| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutRiemann</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;">PutRiemann</h1><h2>Description: </h2><p>Send events to Riemann (http://riemann.io) when FlowFiles pass through this processor. You can use events to notify Riemann that a FlowFile passed through, or you can attach a more meaningful metric, such as, the time a FlowFile took to get to this processor. All attributes attached to events support the NiFi Expression Language.</p><h3>Tags: </h3><p>riemann, monitoring, metrics</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>Riemann Address</strong></td><td>Riemann Address</td><td></td><td id="allowable-values"></td><td id="description">Hostname of Riemann server</td></tr><tr><td id="name"><strong>Riemann Port</strong></td><td>Riemann Port</td><td id="default-value">5555</td><td id="allowable-values"></td><td id="description">Port that Riemann is listening on</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td>Transport Protocol</td><td id="default-value">TCP</td><td id="allowable-values"><ul><li>TCP</li><li>UDP</li></ul></td><td id="description">Transport protocol to speak to Riemann in</td></tr><tr><td id="name"><strong>Timeout</strong></td><td>Timeout</td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Timeout in milliseconds when writing events to Riemann</td></tr><tr><td id="name">Batch Size</td><td>Batch Size</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Batch size for incoming FlowFiles</td></tr><tr><td id="name">Description</td><td>Description</td><td></td><td id="allowable-values"></td><td id="description">Description associated to the event<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Service</td><td>Service</td><td></td><td id="allowable-values"></td><td id="description">Name of service associated to this event (e.g. FTP File Fetched)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">State</td><td>State</td><td></td><td id="allowable-values"></td><td id="description">State of service associated to this event in string form (e.g. ok, warning, foo)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Metric</td><td>Metric</td><td></td><td id="allowable-values"></td><td id="description">Floating point number associated to this event<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">TTL</td><td>TTL</td><td></td><td id="allowable-values"></td><td id="description">Floating point value in seconds until Riemann considers this event as "expired"<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Tags</td><td>Tags</td><td></td><td id="allowable-values"></td><td id="description">Comma separated list of tags associated to the event<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Host</td><td>Host</td><td id="default-value">${hostname()}</td><td id="allowable-values"></td><td id="description">A hostname associated to this event (e.g. nifi-app1)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Time</td><td>Time</td><td></td><td id="allowable-values"></td><td id="description">Time of event in unix epoch seconds (long), default: (current time)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">Custom Event Attribute</td><td id="value">Any value or expression</td><td>These values will be attached to the Riemann event as a custom attribute<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Metrics successfully written to Riemann</td></tr><tr><td>failure</td><td>Metrics which failed to write to Riemann</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> |