Description and usage of ParseSyslog5424:

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:

logs, syslog, syslog5424, attributes, system, event, message

Properties:

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.

Name

Default Value

Allowable Values

Description

Character Set

UTF-8 Specifies which character set of the Syslog messages

NIL Policy

NULL * OMIT 
* NULL 
* DASH 
Defines how NIL values are handled for header fields.
Include Message Body in Attributes true * true
* false
If true, then the Syslog Message body will be included in the attributes.

Relationships:

Name

Description

success Any FlowFile that is successfully parsed as a Syslog message will be to this Relationship.
failure Any FlowFile that could not be parsed as a Syslog message will be transferred to this Relationship without any attributes being added

Reads Attributes:

None specified.

Writes Attributes:

Name

Description

syslog.priority The priority of the Syslog message.
syslog.severity The severity of the Syslog message derived from the priority.
syslog.facility The facility of the Syslog message derived from the priority.
syslog.version The optional version from the Syslog message.
syslog.timestamp The timestamp of the Syslog message.
syslog.hostname The hostname or IP address of the Syslog message.
syslog.appname The appname of the Syslog message.
syslog.procid The procid of the Syslog message.
syslog.messageid The messageid the Syslog message.
syslog.structuredData Multiple entries per structuredData of the Syslog message.
syslog.sender The hostname of the Syslog server that sent the message.
syslog.body The body of the Syslog message, everything after the hostname.

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:

None specified.