Skip to content

Commit

Permalink
chore: update component docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@everpcpc
everpcpc committed Mar 2, 2023
1 parent 59c9f7c commit ed2aaaa
Show file tree
Hide file tree
Showing 23 changed files with 483 additions and 161 deletions.
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/amqp.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ base: components: sinks: amqp: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -123,17 +123,31 @@ base: components: sinks: amqp: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -277,17 +277,31 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -256,17 +256,31 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/aws_kinesis_streams.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ base: components: sinks: aws_kinesis_streams: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -256,17 +256,31 @@ base: components: sinks: aws_kinesis_streams: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/aws_s3.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ base: components: sinks: aws_s3: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -365,17 +365,31 @@ base: components: sinks: aws_s3: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/aws_sqs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ base: components: sinks: aws_sqs: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -197,17 +197,31 @@ base: components: sinks: aws_sqs: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/azure_blob.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ base: components: sinks: azure_blob: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -231,17 +231,31 @@ base: components: sinks: azure_blob: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
28 changes: 21 additions & 7 deletions website/cue/reference/components/sinks/base/console.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ base: components: sinks: console: configuration: {
[apache_avro]: https://avro.apache.org/
"""
csv: """
Encodes an event as an CSV message.
Encodes an event as a CSV message.
This codec must be configured with fields to encode.
"""
Expand Down Expand Up @@ -107,17 +107,31 @@ base: components: sinks: console: configuration: {
"""
}
}
csv: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
The CSV Serializer fields.
The order of the fields determines the order of the columns in the CSV output.
Make sure to use the same order when parsing the CSV output.
If a field is not present in the event, the output will be `NaN`.
Some value types: Array, Regex, Object are not supported by the CSV format.
If a field is of an unsupported type, the output will be `NaN`.
"""
required: true
type: array: items: type: string: {}
}
}
except_fields: {
description: "List of fields that will be excluded from the encoded event."
required: false
type: array: items: type: string: {}
}
fields: {
description: "The CSV fields."
relevant_when: "codec = \"csv\""
required: true
type: array: items: type: string: {}
}
metric_tag_values: {
description: """
Controls how metric tag values are encoded.
Expand Down
Loading

0 comments on commit ed2aaaa

Please sign in to comment.