Skip to content

Commit

Permalink
fix(docs, syslog source): Correct docs for syslog_ip (vectordotdev#…
Browse files Browse the repository at this point in the history
…18003)

For UDP/TCP connections it will contain the IP address of the connection
client. There is no
fallback to `hostname` that I can see (nor could I get it to fallback
during testing).

Signed-off-by: Jesse Szwedko <[email protected]>

Signed-off-by: Jesse Szwedko <[email protected]>
  • Loading branch information
jszwedko authored Jul 17, 2023
1 parent 9a6ffad commit a1d3c3a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/cue/reference/components/sources/syslog.cue
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ components: sources: syslog: {
}
}
source_ip: {
description: "The upstream hostname. In the case where `mode` = `\"unix\"` the socket path will be used. (`host` is also this value if `hostname` does not exist in the log.)"
description: "The IP address of the client. In the case where `mode` = `\"unix\"` the socket path will be used."
required: true
type: string: {
examples: ["127.0.0.1"]
Expand Down

0 comments on commit a1d3c3a

Please sign in to comment.