PutSyslog

PutSyslog 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: 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.
Tags: logs, put, syslog, tcp, udp
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Batch Size
The number of incoming FlowFiles to process in a single execution of this processor.

Display Name

Batch Size

Description

The number of incoming FlowFiles to process in a single execution of this processor.

API Name

Batch Size

Default Value

25

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Character Set
Specifies the character set of the Syslog messages. Note that Expression language is not evaluated per FlowFile.

Display Name

Character Set

Description

Specifies the character set of the Syslog messages. Note that Expression language is not evaluated per FlowFile.

API Name

Character Set

Default Value

UTF-8

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Hostname
The IP address or hostname of the Syslog server.

Display Name

Hostname

Description

The IP address or hostname of the Syslog server.

API Name

Hostname

Default Value

localhost

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Idle Connection Expiration
The amount of time a connection should be held open without being used before closing the connection.

Display Name

Idle Connection Expiration

Description

The amount of time a connection should be held open without being used before closing the connection.

API Name

Idle Connection Expiration

Default Value

5 seconds

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Max Size of Socket Send Buffer
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.

Display Name

Max Size of Socket Send Buffer

Description

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.

API Name

Max Size of Socket Send Buffer

Default Value

1 MB

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Message Body
The body for the Syslog messages.

Display Name

Message Body

Description

The body for the Syslog messages.

API Name

Message Body

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Message Hostname
The hostname for the Syslog messages.

Display Name

Message Hostname

Description

The hostname for the Syslog messages.

API Name

Message Hostname

Default Value

${hostname(true)}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Message Priority
The priority for the Syslog messages, excluding < >.

Display Name

Message Priority

Description

The priority for the Syslog messages, excluding < >.

API Name

Message Priority

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Message Timestamp
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".

Display Name

Message Timestamp

Description

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".

API Name

Message Timestamp

Default Value

${now():format('MMM d HH:mm:ss')}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Message Version
The version for the Syslog messages.

Display Name

Message Version

Description

The version for the Syslog messages.

API Name

Message Version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Port
The port for Syslog communication. Note that Expression language is not evaluated per FlowFile.

Display Name

Port

Description

The port for Syslog communication. Note that Expression language is not evaluated per FlowFile.

API Name

Port

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Protocol
The protocol for Syslog communication.
Display Name

Protocol

Description

The protocol for Syslog communication.

API Name

Protocol

Default Value

UDP

Allowable Values
- TCP
- UDP
Expression Language Scope

Not Supported

Sensitive

false

Required

true
SSL Context Service
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.
Display Name

SSL Context Service

Description

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.

API Name

SSL Context Service

Service Interface

org.apache.nifi.ssl.SSLContextService

Service Implementations

org.apache.nifi.ssl.StandardRestrictedSSLContextService

org.apache.nifi.ssl.StandardSSLContextService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Protocol is set to any of [TCP]
Timeout
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.

Display Name

Timeout

Description

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.

API Name

Timeout

Default Value

10 seconds

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Relationships

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.