LogAttribute

Description:

Emits attributes of the FlowFile at the specified log level

Tags:

attributes, logging

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Log LevelLog Levelinfo
  • trace
  • debug
  • info
  • warn
  • error
The Log Level to use when logging the Attributes
Log PayloadLog Payloadfalse
  • true
  • false
If true, the FlowFile's payload will be logged, in addition to its attributes; otherwise, just the Attributes will be logged.
Attributes to LogAttributes to LogA comma-separated list of Attributes to Log. If not specified, all attributes will be logged unless `Attributes to Log by Regular Expression` is modified. There's an AND relationship between the two properties.
Attributes to Log by Regular Expressionattributes-to-log-regex.*A regular expression indicating the Attributes to Log. If not specified, all attributes will be logged unless `Attributes to Log` is modified. There's an AND relationship between the two properties.
Attributes to IgnoreAttributes to IgnoreA comma-separated list of Attributes to ignore. If not specified, no attributes will be ignored unless `Attributes to Ignore by Regular Expression` is modified. There's an OR relationship between the two properties.
Attributes to Ignore by Regular Expressionattributes-to-ignore-regexA regular expression indicating the Attributes to Ignore. If not specified, no attributes will be ignored unless `Attributes to Ignore` is modified. There's an OR relationship between the two properties.
Log FlowFile PropertiesLog FlowFile Propertiestrue
  • true
  • false
Specifies whether or not to log FlowFile "properties", such as Entry Date, Lineage Start Date, and content size
Output FormatOutput FormatLine per Attribute
  • Line per Attribute Each FlowFile attribute will be logged using a single line for the attribute name and another line for the attribute value. This format is often most advantageous when looking at the attributes of a single FlowFile.
  • Single Line All FlowFile attribute names and values will be logged on a single line. This format is often most advantageous when comparing logs from multiple FlowFiles.
Specifies the format to use for logging FlowFile attributes
Log prefixLog prefixLog prefix appended to the log lines. It helps to distinguish the output of multiple LogAttribute processors.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Character Setcharacter-setUTF-8The name of the CharacterSet to use
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successAll FlowFiles are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

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.