Listens for RELP messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more RELP frames. In the case where the RELP frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing.
listen, relp, 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 |
|---|---|---|---|---|
| Local Network Interface | Local Network Interface | The name of a local network interface to be used to restrict listening to a specific LAN. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Port | Port | The port to listen on for communication. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Receive Buffer Size | Receive Buffer Size | 65507 B | The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages. | |
| Max Size of Message Queue | Max Size of Message Queue | 10000 | The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor during these surges. | |
| Max Size of Socket Buffer | Max Size of Socket Buffer | 1 MB | The maximum size of the socket 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. | |
| Character Set | Character Set | UTF-8 | Specifies the character set of the received data. | |
| Max Number of Worker Threads | Max Number of TCP Connections | 2 | The maximum number of worker threads available for servicing TCP connections. | |
| Max Batch Size | Max Batch Size | 1 | The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages | |
| Batching Message Delimiter | Message Delimiter | \n | Specifies the delimiter to place between messages when multiple messages are bundled together (see <Max Batch Size> property). | |
| SSL Context Service | SSL Context Service | Controller Service API: RestrictedSSLContextService Implementation: StandardRestrictedSSLContextService | The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be received over a secure connection. | |
| Client Auth | Client Auth | REQUIRED |
| The client authentication policy to use for the SSL Context. Only used if an SSL Context Service is provided. |
| Name | Description |
|---|---|
| success | Messages received successfully will be sent out this relationship. |
| Name | Description |
|---|---|
| relp.command | The command of the RELP frames. |
| relp.sender | The sending host of the messages. |
| relp.port | The sending port the messages were received over. |
| relp.txnr | The transaction number of the message. Only included if <Batch Size> is 1. |
| mime.type | The mime.type of the content which is text/plain |