blob: 36bb545c6f87cb162b4d2e9a55db6383cd799ba4 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AmbariReportingTask</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;">AmbariReportingTask</h1><h2>Description: </h2><p>Publishes metrics from NiFi to Ambari Metrics Service (AMS). Due to how the Ambari Metrics Service works, this reporting task should be scheduled to run every 60 seconds. Each iteration it will send the metrics from the previous iteration, and calculate the current metrics to be sent on next iteration. Scheduling this reporting task at a frequency other than 60 seconds may produce unexpected results.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, ambari, 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>Metrics Collector URL</strong></td><td>Metrics Collector URL</td><td id="default-value">http://localhost:6188/ws/v1/timeline/metrics</td><td id="allowable-values"></td><td id="description">The URL of the Ambari Metrics Collector Service<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Application ID</strong></td><td>Application ID</td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The Application ID to be included in the metrics sent to Ambari<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Hostname</strong></td><td>Hostname</td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The Hostname of this NiFi instance to be included in the metrics sent to Ambari<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Process Group ID</td><td>Process Group ID</td><td></td><td id="allowable-values"></td><td id="description">If specified, the reporting task will send metrics about this process group only. If not, the root process group is used and global metrics are sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>