AzureLogAnalyticsProvenanceReportingTask

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

Batch Size

Specifies how many records to send in a single batch, at most.

Display Name: Batch Size
Description: Specifies how many records to send in a single batch, at most.
API Name: Batch Size
Default Value: 1000
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Include Null Values

Indicate if null values should be included in records. Default will be false

Display Name

Include Null Values

Description

Indicate if null values should be included in records. Default will be false

API Name

include-null-values

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

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

Instance URL

The URL of this instance to use in the Content URI of each event.

Display Name: Instance URL
Description: The URL of this instance to use in the Content URI of each event.
API Name: Instance URL
Default Value: http://${hostname(true)}:8080/nifi
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

Display Name: Log Analytics Custom Log Name
Description: Log Analytics Custom Log Name
API Name: Log Analytics Custom Log Name
Default Value: nifiprovenance
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

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

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

Platform

The value to use for the platform field in each event.

Display Name: Platform
Description: The value to use for the platform field in each event.
API Name: Platform
Default Value: nifi
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Event Type to Include

Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Event Type to Include
Description: Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-event-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Event Type to Exclude

Comma-separated list of event types that will be used to exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Event Type to Exclude
Description: Comma-separated list of event types that will be used to exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-event-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component ID to Include

Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component ID to Include
Description: Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-id-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component ID to Exclude

Comma-separated list of component UUID that will be used to exclude the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component ID to Exclude
Description: Comma-separated list of component UUID that will be used to exclude the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-id-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Name to Include

Regular expression to filter the provenance events based on the component name. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component Name to Include
Description: Regular expression to filter the provenance events based on the component name. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-name-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Name to Exclude

Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component Name to Exclude
Description: Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-name-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Type to Include

Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component Type to Include
Description: Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-type-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Type to Exclude

Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component Type to Exclude
Description: Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-type-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Start Position

If the Reporting Task has never been run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start

Display Name

Start Position

Description

If the Reporting Task has never been run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start

API Name

start-position

Default Value

beginning-of-stream

Allowable Values

Beginning of Stream
End of Stream

Expression Language Scope

Not Supported

Sensitive

false

Required

true

AzureLogAnalyticsProvenanceReportingTask 2.0.0