AzureLogAnalyticsReportingTask
Description
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.
Tags
azure, log analytics, metrics, reporting
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 Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Send JVM Metrics * | Send JVM Metrics | false |
| Send JVM Metrics in addition to the NiFi-metrics |
| Log Analytics Workspace Id * | Log Analytics Workspace Id | Log Analytics Workspace Id Supports Expression Language, using Environment variables. | ||
| Log Analytics Custom Log Name | Log Analytics Custom Log Name | nifimetrics | Log Analytics Custom Log Name Supports Expression Language, using Environment variables. | |
| Log Analytics Workspace Key * | Log Analytics Workspace Key | Azure Log Analytic Worskspace Key Supports Expression Language, using Environment variables. | ||
| Application ID * | Application ID | nifi | The Application ID to be included in the metrics sent to Azure Log Analytics WS Supports Expression Language, using Environment variables. | |
| Instance ID * | Instance ID | ${hostname(true)} | Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS Supports Expression Language, using Environment variables. | |
| Process group ID(s) | Process group ID(s) | 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. Supports Expression Language, using Environment variables. | ||
| Job Name | Job Name | nifi_reporting_job | The name of the exporting job Supports Expression Language, using Environment variables. | |
| Log Analytics URL Endpoint Format | Log Analytics URL Endpoint Format | https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01 | Log Analytics URL Endpoint Format Supports Expression Language, using Environment variables. |
State Management
This component does not store state.
Restricted
This component is not restricted.
System Resource Considerations
This component does not specify system resource considerations.