AzureLogAnalyticsProvenanceReportingTask
Description
Publishes Provenance events to to a Azure Log Analytics workspace.
Tags
azure, log analytics, provenace, 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 |
|---|---|---|---|---|
| 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 | nifiprovenance | 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. | |
| 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. | |
| Event Type to Include | s2s-prov-task-event-filter | 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. Supports Expression Language, using Environment variables. | ||
| Event Type to Exclude | s2s-prov-task-event-filter-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. Supports Expression Language, using Environment variables. | ||
| Component Type to Include | s2s-prov-task-type-filter | 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. Supports Expression Language, using Environment variables. | ||
| Component Type to Exclude | s2s-prov-task-type-filter-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. Supports Expression Language, using Environment variables. | ||
| Component ID to Include | s2s-prov-task-id-filter | 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. Supports Expression Language, using Environment variables. | ||
| Component ID to Exclude | s2s-prov-task-id-filter-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. Supports Expression Language, using Environment variables. | ||
| Component Name to Include | s2s-prov-task-name-filter | 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. Supports Expression Language, using Environment variables. | ||
| Component Name to Exclude | s2s-prov-task-name-filter-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. Supports Expression Language, using Environment variables. | ||
| Start Position * | start-position | Beginning of Stream |
| 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 Values * | include-null-values | false |
| Indicate if null values should be included in records. Default will be false |
| Platform * | Platform | nifi | The value to use for the platform field in each event. Supports Expression Language, using Environment variables. | |
| Instance URL * | Instance URL | http://${hostname(true)}:8080/nifi | The URL of this instance to use in the Content URI of each event. Supports Expression Language, using Environment variables. | |
| Batch Size * | Batch Size | 1000 | Specifies 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
This component does not specify system resource considerations.