Sends Syslog messages to a given host and port over TCP or UDP. Messages are constructed from the "Message ___" properties of the processor which can use expression language to generate messages from incoming FlowFiles. The properties are used to construct messages of the form: (<PRIORITY>)(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) where version is optional. The constructed messages are checked against regular expressions for RFC5424 and RFC3164 formatted messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss". If a message is constructed that does not form a valid Syslog message according to the above description, then it is routed to the invalid relationship. Valid messages are sent to the Syslog server and successes are routed to the success relationship, failures routed to the failure relationship.
syslog, put, udp, tcp, logs
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Hostname | Hostname | localhost | The IP address or hostname of the Syslog server. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Protocol | Protocol | UDP |
| The protocol for Syslog communication. |
| Port | Port | The port for Syslog communication. Note that Expression language is not evaluated per FlowFile. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Max Size of Socket Send Buffer | Max Size of Socket Send Buffer | 1 MB | The maximum size of the socket send buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped. Supports Expression Language: true (will be evaluated using variable registry only) | |
| SSL Context Service | SSL Context Service | Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | The Controller Service to use in order to obtain an SSL Context. If this property is set, syslog messages will be sent over a secure connection. This Property is only considered if the [Protocol] Property has a value of "TCP". | |
| Idle Connection Expiration | Idle Connection Expiration | 5 seconds | The amount of time a connection should be held open without being used before closing the connection. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Timeout | Timeout | 10 seconds | The timeout for connecting to and communicating with the syslog server. Does not apply to UDP. Note that Expression language is not evaluated per FlowFile. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Batch Size | Batch Size | 25 | The number of incoming FlowFiles to process in a single execution of this processor. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Character Set | Character Set | UTF-8 | Specifies the character set of the Syslog messages. Note that Expression language is not evaluated per FlowFile. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Message Priority | Message Priority | The priority for the Syslog messages, excluding < >. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Message Version | Message Version | The version for the Syslog messages. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Message Timestamp | Message Timestamp | ${now():format('MMM d HH:mm:ss')} | The timestamp for the Syslog messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", " or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss". Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | |
| Message Hostname | Message Hostname | ${hostname(true)} | The hostname for the Syslog messages. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | |
| Message Body | Message Body | The body for the Syslog messages. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|---|
| success | FlowFiles that are sent successfully to Syslog are sent out this relationship. |
| failure | FlowFiles that failed to send to Syslog are sent out this relationship. |
| invalid | FlowFiles that do not form a valid Syslog message are sent out this relationship. |