PrometheusRecordSink

Description:

Specifies a Record Sink Service that exposes data points to a Prometheus scraping service. Numeric fields are exposed as Gauges, String fields are the label values for the gauges, and all other fields are ignored.

Tags:

record, send, write, prometheus

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
Prometheus Metrics Endpoint Portprometheus-reporting-task-metrics-endpoint-port9092The Port where prometheus metrics can be accessed
Supports Expression Language: true (will be evaluated using variable registry only)
Instance IDprometheus-reporting-task-instance-id${hostname(true)}Id of this NiFi instance to be included in the metrics sent to Prometheus
Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context Serviceprometheus-reporting-task-ssl-contextController Service API:
RestrictedSSLContextService
Implementation: StandardRestrictedSSLContextService
The SSL Context Service to use in order to secure the server. If specified, the server willaccept only HTTPS requests; otherwise, the server will accept only HTTP requests
Client Authenticationprometheus-reporting-task-client-authNo Authentication
  • No Authentication ReportingTask will not authenticate clients. Anyone can communicate with this ReportingTask anonymously
  • Want Authentication ReportingTask will try to verify the client but if unable to verify will allow the client to communicate anonymously
  • Need Authentication ReportingTask will reject communications from any client unless the client provides a certificate that is trusted by the TrustStorespecified in the SSL Context Service
Specifies whether or not the Reporting Task should authenticate clients. This value is ignored if the <SSL Context Service> Property is not specified or the SSL Context provided uses only a KeyStore and not a TrustStore.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.