Syslog

Syslog destination plugin

Syslog destination plugin lets you send your processed telemetry data to a syslog server. With the Syslog destination plugin, you can seamlessly integrate Calyptia Core with various syslog servers, enabling you to transmit your data to remote systems or services over the network. This plugin is a popular choice for logging and monitoring purposes, as it provides a standard mechanism for sending log messages to remote servers. By using the Syslog destination plugin, you can configure your Calyptia Core pipeline to send your data securely and reliably to your syslog server, ensuring that your data reaches its intended destination in a timely and efficient manner.

Configuration parameters

The Syslog destination plugin provides these configuration parameters.

General

Key	Description
Host	Domain or IP address of the remote Syslog server.
Port	TCP or UDP port of the remote Syslog server.
Mode	Desired transport type. Available options are tcp, tls, and udp.
Syslog RFC Format	The Syslog protocol format to use. Available options are rfc3164 and rfc5424.
Syslog Message Key	This is the key name from the original record that contains the message to deliver. Required, otherwise the message is empty.

Advanced

Key	Description
Syslog Severity Key	The key name from the original record that contains the Syslog severity number. This configuration is optional.
Syslog Severity Preset	The preset severity number. It will be overwritten if syslog_severity_key is set and a key of a record is matched. 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 Facility Preset	The preset facility number. It will be overwritten if syslog_facility_key is set and a key of a record is matched. 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 Hostname Preset	The preset hostname. It will be overwritten if syslog_hostname_key is set and a key of a record is matched. 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 Appname Preset	The preset application name. It will be overwritten if syslog_appname_key is set and a key of a record is matched. 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 Message ID Key	The key name from the original record that contains the Message ID associated to the message. This configuration is optional.
Syslog Message ID Preset	The preset message ID. It will be overwritten if syslog_msgid_key is set and a key of a record is matched. This configuration is optional.
Syslog Structured Data (SD) Key	The key name from the original record that contains the Structured Data (SD) content. This configuration is optional.
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_format.rfc3164 sets max size to 1024 bytes. rfc5424 sets the size to 2048 bytes.