SiteToSiteMetricsReportingTask

Description:

Publishes same metrics as the Ambari Reporting task using the Site To Site protocol.

Additional Details...

Tags:

status, metrics, 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
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.
Hostname${hostname(true)}The Hostname of this NiFi instance to be included in the metrics
Supports Expression Language: true (will be evaluated using variable registry only)
Application IDnifiThe Application ID to be included in the metrics
Supports Expression Language: true (will be evaluated using variable registry only)
Output Formatambari-format
  • Ambari Format Metrics will be formatted according to the Ambari Metrics API. See Additional Details in Usage documentation.
  • Record Format Metrics will be formatted using the Record Writer property of this reporting task. See Additional Details in Usage documentation to have the description of the default schema.
The output format that will be used for the metrics. If Record Format is selected, a Record Writer must be provided. If Ambari Format is selected, the Record Writer property should be empty.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.