Monitoring

Eugenia Kuzina

Overview

The Monitoring service implements monitoring in the ADP cluster. It deploys the Prometheus server, which collects and stores metrics. The Monitoring service also supports Grafana for data visualization.

Prometheus retrieves metrics through HTTP calls to specific endpoints. Metrics are transferred to these endpoints by exporters, which should be installed on the cluster hosts.

Monitoring in ADP
Monitoring in ADP
Monitoring in ADP
Monitoring in ADP

The table below describes the components of the Monitoring service and on which hosts they should be installed.

Component Description Host

Prometheus

The Prometheus server that collects and stores metrics

A separate host for monitoring

Grafana

The Grafana web interface for creating dashboards to visualize metrics

A host for Grafana. It is recommended to use a host with a Prometheus server

ADPG Exporter

Sends PostgreSQL metrics

All hosts with the ADPG service

PgBouncer Exporter

Sends PgBouncer metrics

All hosts with the ADPG service

Node Exporter

Sends system metrics

All hosts from which system metrics need to be collected

Patroni and Etcd exposes the /metrics endpoint by default. There is no need to configure a separate exporter for them to support Prometheus scraping. The Balancer (HAProxy) service does not require installation of a separate component to export metrics, but you can configure the parameters of the built-in HAProxy exporter in the Monitoring service settings.

Monitoring service settings

To specify Monitoring service parameters, open the Services tab of the ADP cluster and select the Monitoring service. The parameters are available on the Primary configuration tab.

Prometheus settings
Group Parameter Description Default value

 — 

scrape_interval

Specifies how frequently to scrape targets

1m

 — 

scrape_timeout

Specifies how long to wait until a scrape request times out

10s

 — 

Password for Grafana connection

A password of a Grafana user (admprom_grafana) that is used to connect to Prometheus. The password should contain a combination of uppercase [A-Z] and lowercase [a-z] English letters, digits [0-9], special characters and have a minimum length of 8

 — 

 — 

Prometheus users to login/logout to Prometheus

User credentials for logging into the Prometheus web interface

 — 

Service parameters

config.file

Path to the Prometheus server configuration file

/etc/admprom/prometheus/prometheus.yml

storage.tsdb.path

Path to the Prometheus server database

/var/lib/admprom/prometheus

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

web.config.file

Specifies which web configuration file to load. The file should have the YAML format

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

storage.tsdb.retention.time

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

15d

web.listen-address

Address to access the Prometheus web interface

0.0.0.0:11200
Grafana settings
Parameter Description Default value

Grafana administrator’s password

Password of the Grafana admin user. The password should include uppercase [A-Z] and lowercase [a-z] English letters, digits [0-9], and special characters

 — 

Grafana listen port

Port to access the Grafana web interface

11210
Node Exporter settings
Parameter Description Default value

Listen port

Port on the cluster’s host to access host system metrics in the Prometheus format

11203

Metrics endpoint

Endpoint on the cluster’s host to retrieve system metrics in the Prometheus format

/metrics
SSL configuration

 

Parameter Description Default value Mandatory

[Prometheus] → Enable SSL

Enables SSL encryption of incoming traffic for the Prometheus Server component

Disabled

No

[Prometheus] → Certificate file

Path to the server SSL certificate file for the Prometheus Server component

/etc/admprom/prometheus/server.crt

Yes, if [Prometheus] → Enable SSL enabled

[Prometheus] → Private key file

Path to the file with the private key of the server SSL certificate for the Prometheus Server component

/etc/admprom/prometheus/server.key

Yes, if [Prometheus] → Enable SSL enabled

[Prometheus] → Certificate authority file

Path to the file with the CA certificate to verify Prometheus targets

/etc/admprom/prometheus/ca.crt

No

[Grafana] → Enable SSL

Enables SSL encryption of incoming traffic for the Grafana component

Disabled

No

[Grafana] → Certificate file

Path to the server SSL certificate file for the Grafana component

/etc/admprom/grafana/server.crt

Yes, if [Grafana] → Enable SSL enabled

[Grafana] → Private key file

Path to the file with the private key of the server SSL certificate for the Grafana component

/etc/admprom/grafana/server.key

Yes, if [Grafana] → Enable SSL enabled

[Grafana] → Certificate authority file

Path to the file with the CA certificate to verify Prometheus certificate

/etc/admprom/grafana/ca.crt

No

[Node-exporter] → Enable SSL

Enables SSL encryption of incoming traffic for the Node Exporter component

Disabled

No

[Node-exporter] → Certificate file

Path to the server SSL certificate file for the Node Exporter component

/etc/ssl/server.crt

Yes, if [Node-exporter] → Enable SSL enabled

[Node-exporter] → Private key file

Path to the file with the private key of the server SSL certificate for the Node Exporter component

/etc/ssl/server.key

Yes, if [Node-exporter] → Enable SSL enabled

Set SSL rights for certs/key

Determines whether permissions and owners of SSL certificate and key files can be changed by means of the operating system

Disabled

No
HAProxy Exporter settings
Parameter Description Default value

Listen port

Port on the host with the Balancer service to retrieve HAProxy metrics in the Prometheus format

8405

Metrics endpoint

Endpoint on the host with the Balancer service to retrieve HAProxy metrics in the Prometheus format

/metrics
PgBouncer Exporter settings
Parameter Description Default value

Listen port

Port on the host with the ADPG service to retrieve connection pooler metrics in the Prometheus format

9188
ADPG Exporter settings
Parameter Description Default value

Listen port

Port on the host with the ADPG service to retrieve PostgreSQL metrics in the Prometheus format

9187

The Prometheus settings → Password for Grafana connection and Grafana settings → Grafana administrator’s password parameters are mandatory and should be specified during the monitoring installation.

The Monitoring service metrics are described in ADP monitoring metrics.

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