syslog
The syslog driver configuration is a map.
It can send logs to syslog over:
a UNIX socket, which is the default
a UDP socket
The message format can be:
rfc3164, which is default
rfc5424
The supported keys are described below.
target_unix
optional, type: mix
Use this to send syslog to a custom UNIX socket path.
The value can be a map, with the following keys:
path
required, type: absolute path
Syslog daemon socket path.
If the value type is str, the value should be the same as the value as path above.
default: not set
target_udp
optional, type: mix
Use this to send syslog to a remote syslog daemon listening on UDP.
The value can be a map, with the following keys:
address
required, type: env sockaddr str
Remote socket address.
bind_ip
optional, type: ip addr str
Local IP address to bind for the client socket.
default: not set
If the value type is str, the value should be the same as the value as address above.
default: not set
target
optional, type: map
Alternative form for setting the syslog target.
The key udp is just handled as target_udp as above.
The key unix is just handled as target_unix as above.
format_rfc5424
optional, type: mix
Enable RFC 5424 message format.
The value can be a map, with the following keys:
enterprise_id
optional, type: int
Enterprise ID value as described in rfc5424.
See PRIVATE ENTERPRISE NUMBERS for IANA allocated numbers.
default: 0, which is reserved
message_id
optional, type: str
Message ID.
default: not set
If the value type is int, the value should be the same as the value as enterprise_id above. If the value type is str, the value should be the same as the value as message_id above.
default: not set
use_cee_log_syntax
optional, type: bool
Enable CEE Log Syntax.
Enable this option if you need to use rsyslog mmjsonparse module.
default: not set
cee_event_flag
optional, type: ascii string
Custom CEE event flag. Only meaningful when use_cee_log_syntax is enabled.
The one defined by CLT is @cee:, you can override it by using this option.
default: @cee:
emit_hostname
optional, type: bool
Controls whether the hostname is included in the syslog message header.
default: false
append_report_ts
optional, type: bool
Controls whether report_ts is added to logs.
default: false