Skip to content

fix(syslog source, docs): Fix docs for host field for syslog source #18453

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
jszwedko merged 3 commits into from
Sep 6, 2023
Merged

fix(syslog source, docs): Fix docs for host field for syslog source #18453

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecb9ea8
fix(syslog source, docs): Fix docs for `host` field for syslog source
jszwedko Sep 1, 2023
3f25b79
Add note about fallback to the peer IP
jszwedko Sep 1, 2023
327add5
Feedback
jszwedko Sep 6, 2023
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
10 changes: 8 additions & 2 deletions website/cue/reference/components/sources/syslog.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,15 @@ components: sources: syslog: {
examples: ["app-name"]
}
}
host: fields._local_host
host: {
description: "Same as `hostname` if that field is set, or the IP address of the peer otherwise."
required: true
type: string: {
examples: ["my.host.com", "127.0.0.1"]
}
}
hostname: {
description: "The hostname extracted from the Syslog line. (`host` is also this value if it exists in the log.)"
description: "The `hostname` field extracted from the Syslog line. If a `hostname` field is found, `host` is also set to this value."
required: true
type: string: {
examples: ["my.host.com"]
Expand Down