Syslog
The Syslog output plugin allows you to deliver messages to Syslog servers. It supports RFC3164 and RFC5424 formats through different transports such as UDP, TCP or TLS.
As of Fluent Bit v1.5.3 the configuration is very strict. You must be aware of the structure of your original record so you can configure the plugin to use specific keys to compose your outgoing Syslog message.
Future versions of Fluent Bit are expanding this plugin feature set to support better handling of keys and message composing.
Configuration Parameters
Key | Description | Default |
---|---|---|
host | Domain or IP address of the remote Syslog server. | 127.0.0.1 |
port | TCP or UDP port of the remote Syslog server. | 514 |
mode | Desired transport type. Available options are | udp |
syslog_format | The Syslog protocol format to use. Available options are | rfc5424 |
syslog_maxsize | The maximum size allowed per message. The value must be an integer representing the number of bytes allowed. If no value is provided, the default size is set depending of the protocol version specified by | |
syslog_severity_key | The key name from the original record that contains the Syslog severity number. This configuration is optional. | |
syslog_facility_key | The key name from the original record that contains the Syslog facility number. This configuration is optional. | |
syslog_hostname_key | The key name from the original record that contains the hostname that generated the message. This configuration is optional. | |
syslog_appname_key | The key name from the original record that contains the application name that generated the message. This configuration is optional. | |
syslog_procid_key | The key name from the original record that contains the Process ID that generated the message. This configuration is optional. | |
syslog_msgid_key | The key name from the original record that contains the Message ID associated to the message. This configuration is optional. | |
syslog_sd_key | The key name from the original record that contains the Structured Data (SD) content. This configuration is optional. | |
syslog_message_key | The key name from the original record that contains the message to deliver. Note that this property is mandatory, otherwise the message will be empty. |
Examples
Configuration File
Get started quickly with this configuration file:
Structured Data
The following is an example of how to configure the syslog_sd_key
to send Structured Data to the remote Syslog server.
Example log:
Example configuration file:
Example output:
Last updated