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:

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.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Character SetCharacter SetUTF-8Specifies which character set of the Syslog messages
NIL Policynil_policyNULL
  • OMIT The missing field will not have an attribute added.
  • NULL The missing field will have an empty attribute added.
  • DASH The missing field will have an attribute added with the value of '-'.
Defines how NIL values are handled for header fields.
Include Message Body in Attributesinclude_policytrue
  • true
  • false
If true, then the Syslog Message body will be included in the attributes.

Relationships:

NameDescription
successAny FlowFile that is successfully parsed as a Syslog message will be to this Relationship.
failureAny 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:

NameDescription
syslog.priorityThe priority of the Syslog message.
syslog.severityThe severity of the Syslog message derived from the priority.
syslog.facilityThe facility of the Syslog message derived from the priority.
syslog.versionThe optional version from the Syslog message.
syslog.timestampThe timestamp of the Syslog message.
syslog.hostnameThe hostname or IP address of the Syslog message.
syslog.appnameThe appname of the Syslog message.
syslog.procidThe procid of the Syslog message.
syslog.messageidThe messageid the Syslog message.
syslog.structuredDataMultiple entries per structuredData of the Syslog message.
syslog.senderThe hostname of the Syslog server that sent the message.
syslog.bodyThe 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.

See Also:

ListenSyslog, ParseSyslog, PutSyslog