Monitoring configuration parameters

Olga Semme

Collapse content Expand content

To configure the service, use the following configuration parameters in ADCM.

NOTE

Some of the parameters become visible in the ADCM UI after the Advanced flag has been set.
The parameters that are set in the Custom group will overwrite the existing parameters even if they are read-only.

Prometheus settings

Group Parameter Description Default value

—

scrape_interval

Specifies how frequently to scrape targets

—

scrape_timeout

Specifies how long to wait until a scrape request times out

10s

—

Password for grafana connection

Password of a Grafana user (admprom_grafana) to connect to Prometheus

—

Prometheus users to login/logout to Prometheus

User credentials for logging into the Prometheus web interface

—

Service parameters

config.file

Path to Prometheus server configuration file

/etc/admprom/prometheus/prometheus.yml

web.config.file

Specifies which web configuration file to load. The file is written in YAML format

/etc/admprom/prometheus/prometheus-auth.yml

storage.tsdb.path

Prometheus server database path

/var/lib/admprom/prometheus

web.listen-address

Address to access the Prometheus web interface

0.0.0.0:11200

web.console.libraries

Path to console management libraries

/usr/share/admprom/prometheus/console_libraries

web.console.templates

Path to Prometheus server console templates

/usr/share/admprom/prometheus/consoles

storage.tsdb.retention.time

Specifies how long to retain samples in the storage. Supported units: y, w, d, h, m, s, ms

15d

Add property

Parameters and their values entered in this field override the parameters specified in the ADCM user interface. This field also allows you to set values for all user parameters that are not displayed in the interface, but are allowed in the configuration file prometheus.yml

—

Grafana settings

Parameter

Description

Default value

Grafana administrator’s password

Password of a Grafana administrator user

—

Grafana listen port

Port to access the Grafana web interface

11210

Node exporter settings

Parameter

Description

Default value

Listen port

Port to access ADS host system metrics in Prometheus format

11203

Metrics endpoint

Endpoint to which the Node exporter exports system metrics in Prometheus format

/metrics

SSL configuration

Parameter

Description

Default value

[Prometheus] → Enable SSL

Option to enable SSL for Prometheus

false

[Prometheus] → Certificate file

Path to the server SSL certificate file in the PEM format

/etc/admprom/prometheus/server.crt

[Prometheus] → Private key file

Path to the file with the private key of the server SSL certificate

/etc/admprom/prometheus/server.key

[Prometheus] → Certificate authority file

Path to the CA file (used to verify targets)

/etc/admprom/prometheus/ca.crt

[Grafana] → Enable SSL

Option to enable SSL for Grafana

false

[Grafana] → Certificate file

Path to the server SSL certificate file in the PEM format

/etc/admprom/grafana/server.crt

[Grafana] → Private key file

Path to the file with the private key of the server SSL certificate

/etc/admprom/grafana/server.key

[Grafana] → Certificate authority file

Path to the CA file (used to verify Prometheus certificate)

/etc/admprom/grafana/ca.crt

[Node-exporter] → Enable SSL

Option to enable SSL for Node-exporter

false

[Node-exporter] → Certificate file

Path to the server SSL certificate file in the PEM format

/etc/ssl/server.crt

[Node-exporter] → Private key file

Path to the file with the private key of the server SSL certificate

/etc/ssl/server.key

Set SSL rights for certs/key

Option to enable changing the permissions and owner of SSL certificate and key files

false

Scrape config for NiFi (nifi_scraper.yml)

Parameters for configuring the Prometheus service to collect NiFi metrics. Metrics are available through the built-in REST API endpoint — http://<nifi host>:<nifi port>/nifi-api/flow/metrics/prometheus.

Parameter Description Default value

job_name

The default task name assigned for collecting metrics

nifi-monitoring

scrape_interval

Time interval between metric collections

scrape_timeout

Per-scrape timeout when scraping this job. Cannot be longer than scrape_interval

Scrape config for NiFi2 (nifi2_scraper.yml)

Parameter Description Default value

job_name

The default task name assigned for collecting metrics

nifi2-monitoring

scrape_interval

Time interval between metric collections

scrape_timeout

Per-scrape timeout when scraping this job. Cannot be longer than scrape_interval

Scrape config for Kafka.BROKER (kafka_broker_scraper.yml)

Parameters for configuring the Prometheus service to collect Kafka metrics.

Parameter Description Default value

job_name

The default task name assigned for collecting metrics

kafka-jmx-exporter

scrape_interval

Time interval between metric collections

scrape_timeout

Per-scrape timeout when scraping this job. Cannot be longer than scrape_interval

Scrape config for Kafka-Connect (kafka_connect_scraper.yml)

Parameters for configuring the Prometheus service to collect Kafka Connect metrics.

Parameter Description Default value

job_name

The default task name assigned for collecting metrics

kafka-connect-jmx-exporter

scrape_interval

Time interval between metric collections

scrape_timeout

Per-scrape timeout when scraping this job. Cannot be longer than scrape_interval

Scrape config for Kafka REST Proxy (kafka_rest_scraper.yml)

Parameters for configuring the Prometheus service to collect Kafka REST Proxy metrics.

Parameter Description Default value

job_name

The default task name assigned for collecting metrics

kafka-rest-jmx-exporter

scrape_interval

Time interval between metric collections

scrape_timeout

Per-scrape timeout when scraping this job. Cannot be longer than scrape_interval

Found a mistake? Seleсt text and press Ctrl+Enter to report it