Skip to content

feat(website): add input telemetry types section for transforms and sinks #23222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pront merged 4 commits into from
Jun 17, 2025
Merged

feat(website): add input telemetry types section for transforms and sinks #23222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6d55cf
external(docs): mention that encoding config can change what telemetr…
pront Jun 17, 2025
4ada77d
feat(website): add input telemetry types section
pront Jun 17, 2025
50effff
remove weird char
pront Jun 17, 2025
1801f6e
visual improvements
pront Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/codecs/encoding/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
7 changes: 4 additions & 3 deletions website/cue/reference/components.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]: {
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/amqp.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_kinesis_streams.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_s3.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_sns.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/aws_sqs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/azure_blob.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/console.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/file.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/gcp_cloud_storage.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/gcp_pubsub.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/http.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/humio_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/kafka.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/loki.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/mqtt.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/nats.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/opentelemetry.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/papertrail.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/pulsar.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/redis.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/socket.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sinks/base/splunk_hec_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
Loading
Loading