| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>LogAttribute</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">LogAttribute</h1><h2>Description: </h2><p>Emits attributes of the FlowFile at the specified log level</p><h3>Tags: </h3><p>attributes, logging</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Log Level</strong></td><td>Log Level</td><td id="default-value">info</td><td id="allowable-values"><ul><li>trace</li><li>debug</li><li>info</li><li>warn</li><li>error</li></ul></td><td id="description">The Log Level to use when logging the Attributes</td></tr><tr><td id="name"><strong>Log Payload</strong></td><td>Log Payload</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the FlowFile's payload will be logged, in addition to its attributes; otherwise, just the Attributes will be logged.</td></tr><tr><td id="name">Attributes to Log</td><td>Attributes to Log</td><td></td><td id="allowable-values"></td><td id="description">A 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.</td></tr><tr><td id="name">Attributes to Log by Regular Expression</td><td>attributes-to-log-regex</td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name">Attributes to Ignore</td><td>Attributes to Ignore</td><td></td><td id="allowable-values"></td><td id="description">A 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.</td></tr><tr><td id="name">Attributes to Ignore by Regular Expression</td><td>attributes-to-ignore-regex</td><td></td><td id="allowable-values"></td><td id="description">A 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.</td></tr><tr><td id="name"><strong>Log FlowFile Properties</strong></td><td>Log FlowFile Properties</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not to log FlowFile "properties", such as Entry Date, Lineage Start Date, and content size</td></tr><tr><td id="name"><strong>Output Format</strong></td><td>Output Format</td><td id="default-value">Line per Attribute</td><td id="allowable-values"><ul><li>Line per Attribute <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Single Line <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li></ul></td><td id="description">Specifies the format to use for logging FlowFile attributes</td></tr><tr><td id="name">Log prefix</td><td>Log prefix</td><td></td><td id="allowable-values"></td><td id="description">Log prefix appended to the log lines. It helps to distinguish the output of multiple LogAttribute processors.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td>character-set</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to use<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |