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, metrics, reporting, log analytics

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Send JVM Metricsfalse
  • true
  • false
Send JVM Metrics in addition to the NiFi-metrics
Log Analytics Workspace IdLog Analytics Workspace Id
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics Custom Log NamenifimetricsLog Analytics Custom Log Name
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics Workspace KeyAzure Log Analytic Worskspace Key
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Application IDnifiThe Application ID to be included in the metrics sent to Azure Log Analytics WS
Supports Expression Language: true (will be evaluated using variable registry only)
Instance ID${hostname(true)}Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS
Supports Expression Language: true (will be evaluated using variable registry only)
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: true (will be evaluated using variable registry only)
Job Namenifi_reporting_jobThe name of the exporting job
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics URL Endpoint Formathttps://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01Log Analytics URL Endpoint Format
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.