fluent-bit-docs icon indicating copy to clipboard operation
fluent-bit-docs copied to clipboard

out_syslog: misleading / incomplete / invalid tls-related documentation

Open bplessis opened this issue 1 year ago • 0 comments

Hi,

Currently the documentation for syslog output state that the plugin support different transports such as UDP, TCP or TLS and document the mode parameter as the selector for this different options.

However while the plugin configuration parsing code does recognise this tls value, the actual plugin code doesn't actually do anything with it, the mode variable is merely used in a 'are we in UDP mode ?' question.

To actually enable tls it's required to use the generic 'tls' parameter like this:

  [OUTPUT]
    name syslog
    mode tcp # or tls
    tls on

Not sure if it's a documentation issue or a code issue, but from some other plugins it does feel more documentation.

Regards, benoit

bplessis avatar Jan 13 '24 10:01 bplessis