AzureLogAnalyticsReportingTask

AzureLogAnalyticsReportingTask 2.0.0

Bundle: org.apache.nifi | nifi-azure-nar
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
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Application ID
The Application ID to be included in the metrics sent to Azure Log Analytics WS

Display Name

Application ID

Description

The Application ID to be included in the metrics sent to Azure Log Analytics WS

API Name

Application ID

Default Value

nifi

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Instance ID
Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS

Display Name

Instance ID

Description

Id of this NiFi instance to be included in the metrics sent to Azure Log Analytics WS

API Name

Instance ID

Default Value

${hostname(true)}

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Job Name
The name of the exporting job

Display Name

Job Name

Description

The name of the exporting job

API Name

Job Name

Default Value

nifi_reporting_job

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Log Analytics Custom Log Name
Log Analytics Custom Log Name

Display Name

Log Analytics Custom Log Name

Description

Log Analytics Custom Log Name

API Name

Log Analytics Custom Log Name

Default Value

nifimetrics

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Log Analytics URL Endpoint Format
Log Analytics URL Endpoint Format

Display Name

Log Analytics URL Endpoint Format

Description

Log Analytics URL Endpoint Format

API Name

Log Analytics URL Endpoint Format

Default Value

https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Log Analytics Workspace Id
Log Analytics Workspace Id

Display Name

Log Analytics Workspace Id

Description

Log Analytics Workspace Id

API Name

Log Analytics Workspace Id

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

true

Required

true
Log Analytics Workspace Key
Azure Log Analytic Worskspace Key

Display Name

Log Analytics Workspace Key

Description

Azure Log Analytic Worskspace Key

API Name

Log Analytics Workspace Key

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

true

Required

true
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.

Display Name

Process group ID(s)

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.

API Name

Process group ID(s)

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Send JVM Metrics
Send JVM Metrics in addition to the NiFi-metrics
Display Name

Send JVM Metrics

Description

Send JVM Metrics in addition to the NiFi-metrics

API Name

Send JVM Metrics

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true