PutSplunk
Description
Sends logs to Splunk Enterprise over TCP, TCP + TLS/SSL, or UDP. If a Message Delimiter is provided, then this processor will read messages from the incoming FlowFile based on the delimiter, and send each message to Splunk. If a Message Delimiter is not provided then the content of the FlowFile will be sent directly to Splunk as if it were a single message.
Tags
logs, splunk, tcp, udp
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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 | Destination hostname or IP address Supports Expression Language, using Environment variables. | |
| Port * | Port | Destination port number Supports Expression Language, using Environment variables. | ||
| 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. | |
| Idle Connection Expiration * | Idle Connection Expiration | 15 seconds | The amount of time a connection should be held open without being used before closing the connection. A value of 0 seconds will disable this feature. Supports Expression Language, using Environment variables. | |
| Timeout | Timeout | 10 seconds | The timeout for connecting to and communicating with the destination. Does not apply to UDP Supports Expression Language, using Environment variables. | |
| Character Set * | Character Set | UTF-8 | Specifies the character set of the data being sent. Supports Expression Language, using Environment variables. | |
| Protocol * | Protocol | TCP |
| The protocol for communication. |
| Message Delimiter | Message Delimiter | Specifies the delimiter to use for splitting apart multiple messages within a single FlowFile. If not specified, the entire content of the FlowFile will be used as a single message. If specified, the contents of the FlowFile will be split on this delimiter and each section sent as a separate message. Note that if messages are delimited and some messages for a given FlowFile are transferred successfully while others are not, the messages will be split into individual FlowFiles, such that those messages that were successfully sent are routed to the 'success' relationship while other messages are sent to the 'failure' relationship. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Specifies the SSL Context Service to enable TLS socket communication |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles that failed to send to the destination are sent out this relationship. |
| success | FlowFiles that are sent successfully to the destination are sent out this relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.