Skip to content

Commit

Permalink
docs: generate component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jorgehermo9
jorgehermo9 committed Nov 4, 2024
1 parent d438fb2 commit 901978c
Show file tree
Hide file tree
Showing 19 changed files with 38 additions and 266 deletions.
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/amqp.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -335,26 +335,14 @@ base: components: sources: amqp: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/aws_kinesis_firehose.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,26 +333,14 @@ base: components: sources: aws_kinesis_firehose: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/aws_s3.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -433,26 +433,14 @@ base: components: sources: aws_s3: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/aws_sqs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,26 +437,14 @@ base: components: sources: aws_sqs: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/datadog_agent.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,26 +330,14 @@ base: components: sources: datadog_agent: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/demo_logs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -326,26 +326,14 @@ base: components: sources: demo_logs: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/exec.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -314,26 +314,14 @@ base: components: sources: exec: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/file_descriptor.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -292,26 +292,14 @@ base: components: sources: file_descriptor: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/gcp_pubsub.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -369,26 +369,14 @@ base: components: sources: gcp_pubsub: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/heroku_logs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -327,26 +327,14 @@ base: components: sources: heroku_logs: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/http.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -342,26 +342,14 @@ base: components: sources: http: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
16 changes: 2 additions & 14 deletions website/cue/reference/components/sources/base/http_client.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,26 +330,14 @@ base: components: sources: http_client: configuration: {
relevant_when: "method = \"chunked_gelf\""
required: false
type: object: options: {
max_chunk_length: {
description: """
The maximum length of a single GELF chunk, in bytes. Chunks longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of chunks and
the per-chunk memory is unbounded.
This limit takes only into account the chunk's payload and the GELF header bytes are excluded from the calculation.
"""
required: false
type: uint: {}
}
max_message_length: {
max_length: {
description: """
The maximum length of a single GELF message, in bytes. Messages longer than this length will
be dropped. If this option is not set, the decoder does not limit the length of messages and
the per-message memory is unbounded.
Note that a message can be composed of multiple chunks and this limit is applied to the whole
message, not to individual chunks. This length should always be greater than the `max_chunk_length`.
This option is useful to limit the memory usage of the decoders's chunk buffer.
message, not to individual chunks.
This limit takes only into account the message's payload and the GELF header bytes are excluded from the calculation.
The message's payload is the concatenation of all the chunks' payloads.
Expand Down
Loading

0 comments on commit 901978c

Please sign in to comment.