SiteToSiteStatusReportingTask

Description:

Publishes Status events using the Site To Site protocol. The component type and name filter regexes form a union: only components matching both regexes will be reported. However, all process groups are recursively searched for matching components, regardless of whether the process group matches the component filters.

Additional Details...

Tags:

status, metrics, history, 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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Destination URLDestination URLThe URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).
Supports Expression Language: true (will be evaluated using variable registry only)
Input Port NameInput Port NameThe name of the Input Port to deliver data to.
Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context ServiceSSL 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 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)
Compress EventsCompress Eventstrue
  • true
  • false
Indicates whether or not to compress the data being sent.
Communications TimeoutCommunications Timeout30 secsSpecifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction
Batch SizeBatch Size1000Specifies how many records to send in a single batch, at most.
Transport Protocols2s-transport-protocolRAW
  • RAW
  • HTTP
Specifies which transport protocol to use for Site-to-Site communication.
HTTP Proxy hostnames2s-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 ports2s-http-proxy-portSpecify the proxy server's port number, optional. If not specified, default port 80 will be used.
HTTP Proxy usernames2s-http-proxy-usernameSpecify an user name to connect to the proxy server, optional.
HTTP Proxy passwords2s-http-proxy-passwordSpecify an user password to connect to the proxy server, optional.
Sensitive Property: true
Record Writerrecord-writerController Service API:
RecordSetWriterFactory
Implementations: RecordSetWriterLookup
XMLRecordSetWriter
FreeFormTextRecordSetWriter
CSVRecordSetWriter
ScriptedRecordSetWriter
AvroRecordSetWriter
JsonRecordSetWriter
ParquetRecordSetWriter
Specifies the Controller Service to use for writing out the records.
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 status record.
Supports Expression Language: true (will be evaluated using variable registry only)
Component Type Filter RegexComponent Type Filter Regex(Processor|ProcessGroup|RemoteProcessGroup|RootProcessGroup|Connection|InputPort|OutputPort)A regex specifying which component types to report. Any component type matching this regex will be included. Component types are: Processor, RootProcessGroup, ProcessGroup, RemoteProcessGroup, Connection, InputPort, OutputPort
Supports Expression Language: true (will be evaluated using variable registry only)
Component Name Filter RegexComponent Name Filter Regex.*A regex specifying which component names to report. Any component name matching this regex will be included.
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.