ParseSyslog5424
Description
Attempts to parse the contents of a well formed Syslog message in accordance to RFC5424 format and adds attributes to the FlowFile for each of the parts of the Syslog message, including Structured Data.Structured Data will be written to attributes as one attribute per item id + parameter see https://tools.ietf.org/html/rfc5424.Note: ParseSyslog5424 follows the specification more closely than ParseSyslog. If your Syslog producer does not follow the spec closely, with regards to using '-' for missing header entries for example, those logs will fail with this parser, where they would not fail with ParseSyslog.
Tags
attributes, event, logs, message, syslog, syslog5424, system
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 |
|---|---|---|---|---|
| Character Set * | Character Set | UTF-8 | Specifies which character set of the Syslog messages | |
| NIL Policy * | nil_policy | NULL |
| Defines how NIL values are handled for header fields. |
| Include Message Body in Attributes | include_policy | true |
| If true, then the Syslog Message body will be included in the attributes. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | Any FlowFile that could not be parsed as a Syslog message will be transferred to this Relationship without any attributes being added |
| success | Any FlowFile that is successfully parsed as a Syslog message will be to this Relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| syslog.appname | The appname of the Syslog message. |
| syslog.body | The body of the Syslog message, everything after the hostname. |
| syslog.facility | The facility of the Syslog message derived from the priority. |
| syslog.hostname | The hostname or IP address of the Syslog message. |
| syslog.messageid | The messageid the Syslog message. |
| syslog.priority | The priority of the Syslog message. |
| syslog.procid | The procid of the Syslog message. |
| syslog.sender | The hostname of the Syslog server that sent the message. |
| syslog.severity | The severity of the Syslog message derived from the priority. |
| syslog.structuredData | Multiple entries per structuredData of the Syslog message. |
| syslog.timestamp | The timestamp of the Syslog message. |
| syslog.version | The optional version from the Syslog message. |
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.