SiteToSiteProvenanceReportingTask

Description:

Publishes Provenance events using the Site To Site protocol.

Additional Details...

Tags:

provenance, lineage, tracking, site, site to site

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
Destination URLThe URL of the destination NiFi instance to send data to, should be a comma-separated list of address in the format of http(s)://host:port/nifi.
Supports Expression Language: true (will be evaluated using variable registry only)
Input Port NameThe name of the Input Port to deliver data to.
Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context ServiceController Service API:
RestrictedSSLContextService
Implementation: StandardRestrictedSSLContextService
The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.
Instance 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)
Compress Eventstrue
  • true
  • false
Indicates whether or not to compress the data being sent.
Communications Timeout30 secsSpecifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction
Batch Size1000Specifies how many records to send in a single batch, at most.
Transport ProtocolRAW
  • RAW
  • HTTP
Specifies which transport protocol to use for Site-to-Site communication.
HTTP Proxy hostnameSpecify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.
HTTP Proxy portSpecify the proxy server's port number, optional. If not specified, default port 80 will be used.
HTTP Proxy usernameSpecify an user name to connect to the proxy server, optional.
HTTP Proxy passwordSpecify an user password to connect to the proxy server, optional.
Sensitive Property: true
Record WriterController Service API:
RecordSetWriterFactory
Implementations: ScriptedRecordSetWriter
JsonRecordSetWriter
CSVRecordSetWriter
AvroRecordSetWriter
XMLRecordSetWriter
FreeFormTextRecordSetWriter
Specifies the Controller Service to use for writing out the records.
PlatformnifiThe value to use for the platform field in each provenance event.
Supports Expression Language: true (will be evaluated using variable registry only)
Event Type to IncludeComma-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 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 IncludeRegular 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 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 IncludeComma-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 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 IncludeRegular 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 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 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

State management:

ScopeDescription
LOCALStores the Reporting Task's last event Id so that on restart the task knows where it left off.

Restricted:

Required PermissionExplanation
export nifi detailsProvides operator the ability to send sensitive details contained in Provenance events to any external system.

System Resource Considerations:

None specified.