Skip to main content

LogAttribute

Description

Emits attributes of the FlowFile at the specified log level

Tags

attributes, logging

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 NameAPI NameDefault ValueAllowable ValuesDescription
Log Level *Log Levelinfo
  • trace
  • debug
  • info
  • warn
  • error
The Log Level to use when logging the Attributes
Log Payload *Log 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 Properties *Log FlowFile Propertiestrue
  • true
  • false
Specifies whether or not to log FlowFile "properties", such as Entry Date, Lineage Start Date, and content size
Output Format *Output FormatLine per Attribute
  • Line per Attribute
  • Single Line
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, using FlowFile attributes and Environment variables.
Character Set *character-setUTF-8The name of the CharacterSet to use

Supports Expression Language, using FlowFile attributes and Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
successAll FlowFiles are routed to 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.

See Also