AzureLogAnalyticsProvenanceReportingTask

Description:

Publishes Provenance events to to a Azure Log Analytics workspace.

Tags:

azure, provenace, 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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Log Analytics Workspace IdLog Analytics Workspace IdLog Analytics Workspace Id
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics Custom Log NameLog Analytics Custom Log NamenifiprovenanceLog Analytics Custom Log Name
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics Workspace KeyLog Analytics Workspace KeyAzure Log Analytic Worskspace Key
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Application IDApplication 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 IDInstance 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)
Job NameJob Namenifi_reporting_jobThe name of the exporting job
Supports Expression Language: true (will be evaluated using variable registry only)
Log Analytics URL Endpoint FormatLog 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)
Event Type to Includes2s-prov-task-event-filterComma-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, 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Event Type to Excludes2s-prov-task-event-filter-excludeComma-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, 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component Type to Includes2s-prov-task-type-filterRegular 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component Type to Excludes2s-prov-task-type-filter-excludeRegular 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component ID to Includes2s-prov-task-id-filterComma-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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component ID to Excludes2s-prov-task-id-filter-excludeComma-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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component Name to Includes2s-prov-task-name-filterRegular 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Component Name to Excludes2s-prov-task-name-filter-excludeRegular 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.
Supports Expression Language: true (will be evaluated using variable registry only)
Start Positionstart-positionBeginning of Stream
  • Beginning of Stream Start reading provenance Events from the beginning of the stream (the oldest event first)
  • End of Stream Start reading provenance Events from the end of the stream, ignoring old events
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
Include Null Valuesinclude-null-valuesfalse
  • true
  • false
Indicate if null values should be included in records. Default will be false
PlatformPlatformnifiThe value to use for the platform field in each event.
Supports Expression Language: true (will be evaluated using variable registry only)
Instance URLInstance URLhttp://${hostname(true)}:8080/nifiThe URL of this instance to use in the Content URI of each event.
Supports Expression Language: true (will be evaluated using variable registry only)
Batch SizeBatch Size1000Specifies how many records to send in a single batch, at most.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.