Syslog (RFC5424) output
The syslog
output sends log records over a socket using the Syslog protocol (RFC 5424). Based on https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-syslog/
kind: SyslogNGOutput
metadata:
name: test
namespace: default
spec:
syslog:
host: 10.12.34.56
transport: tls
tls:
ca_file:
mountFrom:
secretKeyRef:
name: tls-secret
key: ca.crt
cert_file:
mountFrom:
secretKeyRef:
name: tls-secret
key: tls.crt
key_file:
mountFrom:
secretKeyRef:
name: tls-secret
key: tls.key
The following example also configures disk-based buffering for the output. For details, see the Syslog-ng DiskBuffer options.
apiVersion: logging.banzaicloud.io/v1beta1
kind: SyslogNGOutput
metadata:
name: test
namespace: default
spec:
syslog:
host: 10.20.9.89
port: 601
disk_buffer:
disk_buf_size: 512000000
dir: /buffer
reliable: true
template: "$(format-json
--subkeys json.
--exclude json.kubernetes.labels.*
json.kubernetes.labels=literal($(format-flat-json --subkeys json.kubernetes.labels.)))\n"
tls:
ca_file:
mountFrom:
secretKeyRef:
key: ca.crt
name: syslog-tls-cert
cert_file:
mountFrom:
secretKeyRef:
key: tls.crt
name: syslog-tls-cert
key_file:
mountFrom:
secretKeyRef:
key: tls.key
name: syslog-tls-cert
transport: tls
For details on the available options of the output, see the documentation of the AxoSyslog syslog-ng distribution.
Configuration
host (string, required)
Address of the destination host
Default: -
port (int, optional)
The port number to connect to. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
transport (string, optional)
Specifies the protocol used to send messages to the destination server. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
close_on_input (*bool, optional)
By default, syslog-ng OSE closes destination sockets if it receives any input from the socket (for example, a reply). If this option is set to no, syslog-ng OSE just ignores the input, but does not close the socket. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
flags ([]string, optional)
Flags influence the behavior of the destination driver. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
flush_lines (int, optional)
Specifies how many lines are flushed to a destination at a time. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
so_keepalive (*bool, optional)
Enables keep-alive messages, keeping the socket open. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
suppress (int, optional)
Specifies the number of seconds syslog-ng waits for identical messages. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
template (string, optional)
Specifies a template defining the logformat to be used in the destination. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: 0
template_escape (*bool, optional)
Turns on escaping for the ‘, “, and backspace characters in templated output files. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
tls (*TLS, optional)
Sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
ts_format (string, optional)
Override the global timestamp format (set in the global ts-format() parameter) for the specific destination. For details, see the documentation of the AxoSyslog syslog-ng distribution.
Default: -
disk_buffer (*DiskBuffer, optional)
Enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the Syslog-ng DiskBuffer options.
Default: -
persist_name (string, optional)
Unique name for the syslog-ng driver more information
Default: -