diff --git a/src/codecs/encoding/config.rs b/src/codecs/encoding/config.rs index b11fe751a7462..c3d77a5abde2c 100644 --- a/src/codecs/encoding/config.rs +++ b/src/codecs/encoding/config.rs @@ -8,7 +8,8 @@ use vector_lib::configurable::configurable_component; /// Encoding configuration. #[configurable_component] #[derive(Clone, Debug)] -#[configurable(description = "Configures how events are encoded into raw bytes.")] +/// Configures how events are encoded into raw bytes. +/// The selected encoding also determines which input types (logs, metrics, traces) are supported. pub struct EncodingConfig { #[serde(flatten)] encoding: SerializerConfig, diff --git a/website/cue/reference/components.cue b/website/cue/reference/components.cue index a43b0f61f18e3..05a437fe86caa 100644 --- a/website/cue/reference/components.cue +++ b/website/cue/reference/components.cue @@ -439,9 +439,10 @@ components: { } #Input: { - logs: bool - metrics: #MetricInput | null - traces: bool + description?: string + logs: bool + metrics: #MetricInput | null + traces: bool } #LogOutput: [Name=string]: { diff --git a/website/cue/reference/components/sinks/base/amqp.cue b/website/cue/reference/components/sinks/base/amqp.cue index 016cfa8404b0b..0f8c24162cb97 100644 --- a/website/cue/reference/components/sinks/base/amqp.cue +++ b/website/cue/reference/components/sinks/base/amqp.cue @@ -44,8 +44,12 @@ base: components: sinks: amqp: configuration: { type: string: examples: ["amqp://user:password@127.0.0.1:5672/%2f?timeout=10"] } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue index 7eda53f14b84c..a4ca1de78da7a 100644 --- a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue +++ b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue @@ -240,8 +240,12 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { type: bool: default: true } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue index 0f2d80d4e8390..301ba0b2a539c 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue @@ -219,8 +219,12 @@ base: components: sinks: aws_kinesis_firehose: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue index 6028c01ba4241..09b182fd89994 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue @@ -219,8 +219,12 @@ base: components: sinks: aws_kinesis_streams: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_s3.cue b/website/cue/reference/components/sinks/base/aws_s3.cue index 5654d6ac48727..6345607788038 100644 --- a/website/cue/reference/components/sinks/base/aws_s3.cue +++ b/website/cue/reference/components/sinks/base/aws_s3.cue @@ -328,8 +328,12 @@ base: components: sinks: aws_s3: configuration: { type: string: examples: ["application/gzip"] } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_sns.cue b/website/cue/reference/components/sinks/base/aws_sns.cue index 8d183c33d9b04..107cfc7a8a7d8 100644 --- a/website/cue/reference/components/sinks/base/aws_sns.cue +++ b/website/cue/reference/components/sinks/base/aws_sns.cue @@ -150,8 +150,12 @@ base: components: sinks: aws_sns: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/aws_sqs.cue b/website/cue/reference/components/sinks/base/aws_sqs.cue index 0493d2ede171f..b8a0ee23ccc10 100644 --- a/website/cue/reference/components/sinks/base/aws_sqs.cue +++ b/website/cue/reference/components/sinks/base/aws_sqs.cue @@ -150,8 +150,12 @@ base: components: sinks: aws_sqs: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/azure_blob.cue b/website/cue/reference/components/sinks/base/azure_blob.cue index 0bd8b0f494979..5fd082eed789c 100644 --- a/website/cue/reference/components/sinks/base/azure_blob.cue +++ b/website/cue/reference/components/sinks/base/azure_blob.cue @@ -176,8 +176,12 @@ base: components: sinks: azure_blob: configuration: { type: string: examples: ["my-logs"] } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/console.cue b/website/cue/reference/components/sinks/base/console.cue index a140bedf2b276..acd35724c8d26 100644 --- a/website/cue/reference/components/sinks/base/console.cue +++ b/website/cue/reference/components/sinks/base/console.cue @@ -28,8 +28,12 @@ base: components: sinks: console: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/file.cue b/website/cue/reference/components/sinks/base/file.cue index 0cf8178fdae08..bcd793427b2f4 100644 --- a/website/cue/reference/components/sinks/base/file.cue +++ b/website/cue/reference/components/sinks/base/file.cue @@ -48,8 +48,12 @@ base: components: sinks: file: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue index 1b9edc8daea52..57a747fd21cb8 100644 --- a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue +++ b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue @@ -116,8 +116,12 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { type: string: examples: ["c8c65bfa-5f2c-42d4-9189-64bb7b939f2c"] } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue index 45e175ee58aee..0a0b423693bef 100644 --- a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue +++ b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue @@ -189,8 +189,12 @@ base: components: sinks: gcp_cloud_storage: configuration: { type: string: {} } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/gcp_pubsub.cue b/website/cue/reference/components/sinks/base/gcp_pubsub.cue index 17e23079783ae..5db694873ebce 100644 --- a/website/cue/reference/components/sinks/base/gcp_pubsub.cue +++ b/website/cue/reference/components/sinks/base/gcp_pubsub.cue @@ -95,8 +95,12 @@ base: components: sinks: gcp_pubsub: configuration: { type: string: {} } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/http.cue b/website/cue/reference/components/sinks/base/http.cue index 286cf7dd842fb..0632ba766fa5e 100644 --- a/website/cue/reference/components/sinks/base/http.cue +++ b/website/cue/reference/components/sinks/base/http.cue @@ -271,8 +271,12 @@ base: components: sinks: http: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/humio_logs.cue b/website/cue/reference/components/sinks/base/humio_logs.cue index 153dfa5324fdc..546a244d84959 100644 --- a/website/cue/reference/components/sinks/base/humio_logs.cue +++ b/website/cue/reference/components/sinks/base/humio_logs.cue @@ -94,8 +94,12 @@ base: components: sinks: humio_logs: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/kafka.cue b/website/cue/reference/components/sinks/base/kafka.cue index f4ec89ef30d8c..97fecdbb2d2d3 100644 --- a/website/cue/reference/components/sinks/base/kafka.cue +++ b/website/cue/reference/components/sinks/base/kafka.cue @@ -83,8 +83,12 @@ base: components: sinks: kafka: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/loki.cue b/website/cue/reference/components/sinks/base/loki.cue index 218aed6a861fb..4dc8d00fcf13f 100644 --- a/website/cue/reference/components/sinks/base/loki.cue +++ b/website/cue/reference/components/sinks/base/loki.cue @@ -273,8 +273,12 @@ base: components: sinks: loki: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/mqtt.cue b/website/cue/reference/components/sinks/base/mqtt.cue index 12bed930db3c8..c8f4ed9bd1fed 100644 --- a/website/cue/reference/components/sinks/base/mqtt.cue +++ b/website/cue/reference/components/sinks/base/mqtt.cue @@ -38,8 +38,12 @@ base: components: sinks: mqtt: configuration: { type: string: {} } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/nats.cue b/website/cue/reference/components/sinks/base/nats.cue index d663a69f666af..8cf579f6a2e3b 100644 --- a/website/cue/reference/components/sinks/base/nats.cue +++ b/website/cue/reference/components/sinks/base/nats.cue @@ -128,8 +128,12 @@ base: components: sinks: nats: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/opentelemetry.cue b/website/cue/reference/components/sinks/base/opentelemetry.cue index 0f9d2a62585c1..63570c903ab10 100644 --- a/website/cue/reference/components/sinks/base/opentelemetry.cue +++ b/website/cue/reference/components/sinks/base/opentelemetry.cue @@ -274,8 +274,12 @@ base: components: sinks: opentelemetry: configuration: protocol: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/papertrail.cue b/website/cue/reference/components/sinks/base/papertrail.cue index de4bb6b34ba28..b20c940cad1f5 100644 --- a/website/cue/reference/components/sinks/base/papertrail.cue +++ b/website/cue/reference/components/sinks/base/papertrail.cue @@ -28,8 +28,12 @@ base: components: sinks: papertrail: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/pulsar.cue b/website/cue/reference/components/sinks/base/pulsar.cue index b24d5bce94de6..b423fa09c6f73 100644 --- a/website/cue/reference/components/sinks/base/pulsar.cue +++ b/website/cue/reference/components/sinks/base/pulsar.cue @@ -162,8 +162,12 @@ base: components: sinks: pulsar: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/redis.cue b/website/cue/reference/components/sinks/base/redis.cue index e93567ba823fd..9c0b95a42c0a1 100644 --- a/website/cue/reference/components/sinks/base/redis.cue +++ b/website/cue/reference/components/sinks/base/redis.cue @@ -81,8 +81,12 @@ base: components: sinks: redis: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/socket.cue b/website/cue/reference/components/sinks/base/socket.cue index 76e1365789869..cb6aac0fd9fae 100644 --- a/website/cue/reference/components/sinks/base/socket.cue +++ b/website/cue/reference/components/sinks/base/socket.cue @@ -40,8 +40,12 @@ base: components: sinks: socket: configuration: { type: string: examples: ["92.12.333.224:5000", "https://somehost:5000"] } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue index 0c8187c067592..48d07e78b8024 100644 --- a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue +++ b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue @@ -144,8 +144,12 @@ base: components: sinks: splunk_hec_logs: configuration: { type: string: {} } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/webhdfs.cue b/website/cue/reference/components/sinks/base/webhdfs.cue index a011bc24262e5..ca14f7bd07878 100644 --- a/website/cue/reference/components/sinks/base/webhdfs.cue +++ b/website/cue/reference/components/sinks/base/webhdfs.cue @@ -94,8 +94,12 @@ base: components: sinks: webhdfs: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/websocket.cue b/website/cue/reference/components/sinks/base/websocket.cue index d6cadf59f1fbc..0694c649db191 100644 --- a/website/cue/reference/components/sinks/base/websocket.cue +++ b/website/cue/reference/components/sinks/base/websocket.cue @@ -205,8 +205,12 @@ base: components: sinks: websocket: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/base/websocket_server.cue b/website/cue/reference/components/sinks/base/websocket_server.cue index 94c4ce577834c..ada3da7debe2e 100644 --- a/website/cue/reference/components/sinks/base/websocket_server.cue +++ b/website/cue/reference/components/sinks/base/websocket_server.cue @@ -84,8 +84,12 @@ base: components: sinks: websocket_server: configuration: { } } encoding: { - description: "Configures how events are encoded into raw bytes." - required: true + description: """ + Encoding configuration. + Configures how events are encoded into raw bytes. + The selected encoding also determines which input types (logs, metrics, traces) are supported. + """ + required: true type: object: options: { avro: { description: "Apache Avro-specific encoder options." diff --git a/website/cue/reference/components/sinks/websocket_server.cue b/website/cue/reference/components/sinks/websocket_server.cue index 1a76c607aa7ed..31c9d4af42d1d 100644 --- a/website/cue/reference/components/sinks/websocket_server.cue +++ b/website/cue/reference/components/sinks/websocket_server.cue @@ -66,6 +66,10 @@ components: sinks: websocket_server: { } input: { + description: """ + The supported input types depend on the encoding configuration. + This sink accepts any input type supported by the specified encoder. + """ logs: true metrics: { counter: true diff --git a/website/layouts/docs/component.html b/website/layouts/docs/component.html index 93f3e34d66095..9c52d2f2fdf56 100644 --- a/website/layouts/docs/component.html +++ b/website/layouts/docs/component.html @@ -21,7 +21,7 @@ {{ partial "breadcrumb.html" . }} -
{{ . }}
+
+ {{ end }}
+