Configuration parameters of the ADX cluster

Eugenia Kuzina

This article describes the parameters that can be configured for services of an ADX cluster via ADCM. To read about the configuration process, refer to Integrate with a PostgreSQL cluster.

NOTE
Some of the parameters become visible in the ADCM UI after the Show advanced flag being set.

ADP ES Agents

ADP Control Agent settings

 

Parameter Description Default value Mandatory

Xmx ram parameter

Defines the maximum Java heap size for the service in gigabytes

1

Yes

Log level

A logging level of messages written to log files. Possible values: ERROR, WARN, INFO, DEBUG, and TRACE

INFO

Yes
Backup Manager Agent settings

 

Parameter Description Default value Mandatory

Xmx ram parameter

Defines the maximum Java heap size for the service in gigabytes

1

Yes

Log level

A logging level of messages written to log files. Possible values: ERROR, WARN, INFO, DEBUG, and TRACE

INFO

Yes

Third-party database

Parameter Description Default value Mandatory

Data directory

Directory that PostgreSQL uses to store data

 — 

Yes

PostgreSQL listen port

Port to connect to PostgreSQL

5432

Yes

Patroni listen port

Port on a host with PostgreSQL to access Patroni REST API

8008

Yes

Patroni unit name

Systemd unit name of Patroni

 — 

Yes

patronictl binary path

Absolute path to the patronictl file

 — 

Yes

Patroni config path

Absolute path to the patroni.yml configuration file

 — 

Yes

Enable Patroni basic auth

Enables basic HTTP authentication for the Patroni REST API

Disabled

No

Username

Login used for basic HTTP authentication to access Patroni REST API

 — 

Yes, if Enable Patroni basic auth enabled

Password

Password used for basic HTTP authentication to access Patroni REST API

 — 

Yes, if Enable Patroni basic auth enabled

External Prometheus server

Determines if an external Prometheus server is used

Disabled

No

IPv4 address

URL of an external Prometheus server

 — 

Yes, if External Prometheus server enabled

Port

Port to access external Prometheus REST API endpoints

11200

Yes, if External Prometheus server enabled

Username

Basic-auth username to access external Prometheus REST API endpoints

 — 

Yes, if External Prometheus server enabled

Password

Basic-auth password to access external Prometheus REST API endpoints

 — 

Yes, if External Prometheus server enabled

Monitoring

Prometheus settings

 

Group Parameter Description Default value Mandatory

 — 

scrape_interval

Specifies how frequently to scrape targets

1m

Yes

 — 

scrape_timeout

Specifies how long to wait until a scrape request times out

10s

Yes

 — 

Password for grafana connection

Password of a Grafana user (admprom_grafana) that is used to connect to Prometheus

 — 

Yes

 — 

Prometheus users to login/logout to Prometheus

User credentials for logging into the Prometheus web interface

 — 

No

Service parameters

config.file

Path to the Prometheus server configuration file

/etc/admprom/prometheus/prometheus.yml

Yes

web.config.file

Specifies which web configuration file in the YAML format to load

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

Yes

storage.tsdb.path

Path to the Prometheus server database

/var/lib/admprom/prometheus

Yes

web.listen-address

Address to access the Prometheus web interface

0.0.0.0:11200

Yes

web.console.libraries

Path to console management libraries

/usr/share/admprom/prometheus/console_libraries

Yes

web.console.templates

Path to Prometheus server console templates

/usr/share/admprom/prometheus/consoles

Yes

storage.tsdb.retention.time

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

15d

Yes
Grafana settings

 

Parameter Description Default value Mandatory

Grafana administrator’s password

Password of the Grafana admin user

 — 

Yes

Grafana listen port

Port to access the Grafana web interface

11210

Yes
Node Exporter settings

 

Parameter Description Default value Mandatory

Listen port

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

11203

Yes

Metrics endpoint

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

/metrics

Yes
NOTE

In the current version of ADX, the settings from the SSL configuration section are not applied.
Found a mistake? Seleсt text and press Ctrl+Enter to report it