Skip to content
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.

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

fix(external docs): Document additional encoding fields #7127

Merged
merged 1 commit into from
Apr 14, 2021
Merged
Changes from all commits
Commits
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
45 changes: 22 additions & 23 deletions docs/reference/components/sinks.cue
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ components: sinks: [Name=string]: {
}
}

if features.healthcheck.enabled {except_fields: {
except_fields: {
common: false
description: "Prevent the sink from encoding the specified labels."
description: "Prevent the sink from encoding the specified fields."
required: false
type: array: {
default: null
Expand All @@ -174,31 +174,30 @@ components: sinks: [Name=string]: {
}
}

only_fields: {
common: false
description: "Prevent the sink from encoding the specified labels."
required: false
type: array: {
default: null
items: type: string: {
examples: ["message", "parent.child"]
syntax: "field_path"
}
only_fields: {
common: false
description: "Prevent the sink from encoding the specified fields."
required: false
type: array: {
default: null
items: type: string: {
examples: ["message", "parent.child"]
syntax: "field_path"
}
}
}

timestamp_format: {
common: false
description: "How to format event timestamps."
required: false
type: string: {
default: "rfc3339"
enum: {
rfc3339: "Formats as a RFC3339 string"
unix: "Formats as a unix timestamp"
}
syntax: "literal"
timestamp_format: {
common: false
description: "How to format event timestamps."
required: false
type: string: {
default: "rfc3339"
enum: {
rfc3339: "Formats as a RFC3339 string"
unix: "Formats as a unix timestamp"
}
syntax: "literal"
}
}
}
Expand Down