Skip to content

docs(codecs): Document the output type of each decoder #24563

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

Open
matthijskooijman wants to merge 1 commit into
base: master
Choose a base branch
from
+434 −22
Open

docs(codecs): Document the output type of each decoder #24563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions lib/codecs/src/decoding/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,15 +237,21 @@ impl tokio_util::codec::Decoder for Framer {
#[configurable(metadata(docs::enum_tag_description = "The codec to use for decoding events."))]
pub enum DeserializerConfig {
/// Uses the raw bytes as-is.
///
/// This decoder outputs logs.
Bytes,

/// Decodes the raw bytes as [JSON][json].
///
/// This decoder outputs logs.
///
/// [json]: https://www.json.org/
Json(JsonDeserializerConfig),

/// Decodes the raw bytes as [protobuf][protobuf].
///
/// This decoder outputs logs.
///
/// [protobuf]: https://protobuf.dev/
Protobuf(ProtobufDeserializerConfig),

Expand All @@ -264,6 +270,8 @@ pub enum DeserializerConfig {
/// Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
/// [RFC 5424][rfc5424]-style format ("new" style, includes structured data).
///
/// This decoder outputs logs.
///
/// [rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
/// [rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
Syslog(SyslogDeserializerConfig),
Expand Down Expand Up @@ -302,17 +310,23 @@ pub enum DeserializerConfig {
/// Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
/// the codec may continue to relax the enforcement of specification.
///
/// This decoder outputs logs.
///
/// [gelf]: https://docs.graylog.org/docs/gelf
/// [implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
Gelf(GelfDeserializerConfig),

/// Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.
///
/// This decoder outputs metrics.
///
/// [influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
Influxdb(InfluxdbDeserializerConfig),

/// Decodes the raw bytes as as an [Apache Avro][apache_avro] message.
///
/// This decoder outputs logs.
///
/// [apache_avro]: https://avro.apache.org/
Avro {
/// Apache Avro-specific encoder options.
Expand All @@ -321,6 +335,8 @@ pub enum DeserializerConfig {

/// Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.
///
/// This decoder outputs logs.
///
/// [vrl]: https://vector.dev/docs/reference/vrl
Vrl(VrlDeserializerConfig),
}
Expand Down
20 changes: 19 additions & 1 deletion website/cue/reference/components/sinks/generated/websocket_server.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,9 +622,15 @@ generated: components: sinks: websocket_server: configuration: {
avro: """
Decodes the raw bytes as as an [Apache Avro][apache_avro] message.

This decoder outputs logs.

[apache_avro]: https://avro.apache.org/
"""
bytes: "Uses the raw bytes as-is."
bytes: """
Uses the raw bytes as-is.

This decoder outputs logs.
"""
gelf: """
Decodes the raw bytes as a [GELF][gelf] message.

Expand All @@ -640,17 +646,23 @@ generated: components: sinks: websocket_server: configuration: {
Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
the codec may continue to relax the enforcement of specification.

This decoder outputs logs.

[gelf]: https://docs.graylog.org/docs/gelf
[implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
"""
influxdb: """
Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.

This decoder outputs metrics.

[influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
"""
json: """
Decodes the raw bytes as [JSON][json].

This decoder outputs logs.

[json]: https://www.json.org/
"""
native: """
Expand Down Expand Up @@ -684,6 +696,8 @@ generated: components: sinks: websocket_server: configuration: {
protobuf: """
Decodes the raw bytes as [protobuf][protobuf].

This decoder outputs logs.

[protobuf]: https://protobuf.dev/
"""
syslog: """
Expand All @@ -692,12 +706,16 @@ generated: components: sinks: websocket_server: configuration: {
Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
[RFC 5424][rfc5424]-style format ("new" style, includes structured data).

This decoder outputs logs.

[rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
[rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
"""
vrl: """
Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.

This decoder outputs logs.

[vrl]: https://vector.dev/docs/reference/vrl
"""
}
Expand Down
20 changes: 19 additions & 1 deletion website/cue/reference/components/sources/generated/amqp.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,15 @@ generated: components: sources: amqp: configuration: {
avro: """
Decodes the raw bytes as as an [Apache Avro][apache_avro] message.

This decoder outputs logs.

[apache_avro]: https://avro.apache.org/
"""
bytes: "Uses the raw bytes as-is."
bytes: """
Uses the raw bytes as-is.

This decoder outputs logs.
"""
gelf: """
Decodes the raw bytes as a [GELF][gelf] message.

Expand All @@ -108,17 +114,23 @@ generated: components: sources: amqp: configuration: {
Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
the codec may continue to relax the enforcement of specification.

This decoder outputs logs.

[gelf]: https://docs.graylog.org/docs/gelf
[implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
"""
influxdb: """
Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.

This decoder outputs metrics.

[influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
"""
json: """
Decodes the raw bytes as [JSON][json].

This decoder outputs logs.

[json]: https://www.json.org/
"""
native: """
Expand Down Expand Up @@ -152,6 +164,8 @@ generated: components: sources: amqp: configuration: {
protobuf: """
Decodes the raw bytes as [protobuf][protobuf].

This decoder outputs logs.

[protobuf]: https://protobuf.dev/
"""
syslog: """
Expand All @@ -160,12 +174,16 @@ generated: components: sources: amqp: configuration: {
Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
[RFC 5424][rfc5424]-style format ("new" style, includes structured data).

This decoder outputs logs.

[rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
[rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
"""
vrl: """
Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.

This decoder outputs logs.

[vrl]: https://vector.dev/docs/reference/vrl
"""
}
Expand Down
20 changes: 19 additions & 1 deletion website/cue/reference/components/sources/generated/aws_kinesis_firehose.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,15 @@ generated: components: sources: aws_kinesis_firehose: configuration: {
avro: """
Decodes the raw bytes as as an [Apache Avro][apache_avro] message.

This decoder outputs logs.

[apache_avro]: https://avro.apache.org/
"""
bytes: "Uses the raw bytes as-is."
bytes: """
Uses the raw bytes as-is.

This decoder outputs logs.
"""
gelf: """
Decodes the raw bytes as a [GELF][gelf] message.

Expand All @@ -111,17 +117,23 @@ generated: components: sources: aws_kinesis_firehose: configuration: {
Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
the codec may continue to relax the enforcement of specification.

This decoder outputs logs.

[gelf]: https://docs.graylog.org/docs/gelf
[implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
"""
influxdb: """
Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.

This decoder outputs metrics.

[influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
"""
json: """
Decodes the raw bytes as [JSON][json].

This decoder outputs logs.

[json]: https://www.json.org/
"""
native: """
Expand Down Expand Up @@ -155,6 +167,8 @@ generated: components: sources: aws_kinesis_firehose: configuration: {
protobuf: """
Decodes the raw bytes as [protobuf][protobuf].

This decoder outputs logs.

[protobuf]: https://protobuf.dev/
"""
syslog: """
Expand All @@ -163,12 +177,16 @@ generated: components: sources: aws_kinesis_firehose: configuration: {
Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
[RFC 5424][rfc5424]-style format ("new" style, includes structured data).

This decoder outputs logs.

[rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
[rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
"""
vrl: """
Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.

This decoder outputs logs.

[vrl]: https://vector.dev/docs/reference/vrl
"""
}
Expand Down
20 changes: 19 additions & 1 deletion website/cue/reference/components/sources/generated/aws_s3.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,15 @@ generated: components: sources: aws_s3: configuration: {
avro: """
Decodes the raw bytes as as an [Apache Avro][apache_avro] message.

This decoder outputs logs.

[apache_avro]: https://avro.apache.org/
"""
bytes: "Uses the raw bytes as-is."
bytes: """
Uses the raw bytes as-is.

This decoder outputs logs.
"""
gelf: """
Decodes the raw bytes as a [GELF][gelf] message.

Expand All @@ -226,17 +232,23 @@ generated: components: sources: aws_s3: configuration: {
Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
the codec may continue to relax the enforcement of specification.

This decoder outputs logs.

[gelf]: https://docs.graylog.org/docs/gelf
[implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
"""
influxdb: """
Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.

This decoder outputs metrics.

[influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
"""
json: """
Decodes the raw bytes as [JSON][json].

This decoder outputs logs.

[json]: https://www.json.org/
"""
native: """
Expand Down Expand Up @@ -270,6 +282,8 @@ generated: components: sources: aws_s3: configuration: {
protobuf: """
Decodes the raw bytes as [protobuf][protobuf].

This decoder outputs logs.

[protobuf]: https://protobuf.dev/
"""
syslog: """
Expand All @@ -278,12 +292,16 @@ generated: components: sources: aws_s3: configuration: {
Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
[RFC 5424][rfc5424]-style format ("new" style, includes structured data).

This decoder outputs logs.

[rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
[rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
"""
vrl: """
Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.

This decoder outputs logs.

[vrl]: https://vector.dev/docs/reference/vrl
"""
}
Expand Down
20 changes: 19 additions & 1 deletion website/cue/reference/components/sources/generated/aws_sqs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,15 @@ generated: components: sources: aws_sqs: configuration: {
avro: """
Decodes the raw bytes as as an [Apache Avro][apache_avro] message.

This decoder outputs logs.

[apache_avro]: https://avro.apache.org/
"""
bytes: "Uses the raw bytes as-is."
bytes: """
Uses the raw bytes as-is.

This decoder outputs logs.
"""
gelf: """
Decodes the raw bytes as a [GELF][gelf] message.

Expand All @@ -221,17 +227,23 @@ generated: components: sources: aws_sqs: configuration: {
Going forward, Vector will use that [Go SDK][implementation] as the reference implementation, which means
the codec may continue to relax the enforcement of specification.

This decoder outputs logs.

[gelf]: https://docs.graylog.org/docs/gelf
[implementation]: https://github.com/Graylog2/go-gelf/blob/v2/gelf/reader.go
"""
influxdb: """
Decodes the raw bytes as an [Influxdb Line Protocol][influxdb] message.

This decoder outputs metrics.

[influxdb]: https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol
"""
json: """
Decodes the raw bytes as [JSON][json].

This decoder outputs logs.

[json]: https://www.json.org/
"""
native: """
Expand Down Expand Up @@ -265,6 +277,8 @@ generated: components: sources: aws_sqs: configuration: {
protobuf: """
Decodes the raw bytes as [protobuf][protobuf].

This decoder outputs logs.

[protobuf]: https://protobuf.dev/
"""
syslog: """
Expand All @@ -273,12 +287,16 @@ generated: components: sources: aws_sqs: configuration: {
Decodes either as the [RFC 3164][rfc3164]-style format ("old" style) or the
[RFC 5424][rfc5424]-style format ("new" style, includes structured data).

This decoder outputs logs.

[rfc3164]: https://www.ietf.org/rfc/rfc3164.txt
[rfc5424]: https://www.ietf.org/rfc/rfc5424.txt
"""
vrl: """
Decodes the raw bytes as a string and passes them as input to a [VRL][vrl] program.

This decoder outputs logs.

[vrl]: https://vector.dev/docs/reference/vrl
"""
}
Expand Down
Loading
Loading