blob: 63142090283d91b483bd99956117f642623f8d17 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AzureLogAnalyticsReportingTask</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;">AzureLogAnalyticsReportingTask</h1><h2>Description: </h2><p>Sends JVM-metrics as well as Apache NiFi-metrics to a Azure Log Analytics workspace.Apache NiFi-metrics can be either configured global or on process-group level.</p><h3>Tags: </h3><p>azure, metrics, reporting, log analytics</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>Send JVM Metrics</strong></td><td>Send JVM Metrics</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Send JVM Metrics in addition to the NiFi-metrics</td></tr><tr><td id="name"><strong>Log Analytics Workspace Id</strong></td><td>Log Analytics Workspace Id</td><td></td><td id="allowable-values"></td><td id="description">Log Analytics Workspace Id<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Log Analytics Custom Log Name</td><td>Log Analytics Custom Log Name</td><td id="default-value">nifimetrics</td><td id="allowable-values"></td><td id="description">Log Analytics Custom Log Name<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Log Analytics Workspace Key</strong></td><td>Log Analytics Workspace Key</td><td></td><td id="allowable-values"></td><td id="description">Azure Log Analytic Worskspace Key<br/><strong>Sensitive Property: true</strong><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 Azure Log Analytics WS<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Instance ID</strong></td><td>Instance ID</td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Process group ID(s)</td><td>Process group ID(s)</td><td></td><td id="allowable-values"></td><td id="description">If specified, the reporting task will send metrics the configured ProcessGroup(s) only. Multiple IDs should be separated by a comma. If none of the group-IDs could be found or no IDs are defined, 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><tr><td id="name">Job Name</td><td>Job Name</td><td id="default-value">nifi_reporting_job</td><td id="allowable-values"></td><td id="description">The name of the exporting job<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Log Analytics URL Endpoint Format</td><td>Log Analytics URL Endpoint Format</td><td id="default-value">https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01</td><td id="allowable-values"></td><td id="description">Log Analytics URL Endpoint Format<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>