Contents

ADQM Control

ADQM management

 

Parameter Description Default value

ADQM username

Username to connect to ADQM

adqmc

ADQM user password

Password for the ADQM username user to connect to ADQM (should have a minimum length of 8 characters and should not contain #, |, {, }, %, $, ^, /, <, >, ,, ?, ", or ')

 — 

ADQM default port

Default port if it is not exported from an ADQM cluster

9000

ADQM secure port

Default port for SSL-secured communication with ADQM if it is not exported from an ADQM cluster

9440

Connection type

Type of connection (insecure or secure) between ADQM Control and ADQM. Possible values: Insecure (TCP), Secure (TCP secure)

Insecure (TCP)

NOTE

A name and password passed to the ADQM username and ADQM user password parameters should belong to a user account that exists in ADQM. For a new cluster, ADQM provides the default user account without a password by default — you can use this account in ADQM Control, but first assign a password to it. However, it is recommended to create a separate user account in ADQM under which ADQM Control will connect to ADQM, for example:

CREATE USER adqmc ON CLUSTER default_cluster IDENTIFIED WITH sha256_password BY 'qwerty123';
GRANT ON CLUSTER default_cluster SELECT ON *.* TO adqmc;
Backend

 

Parameter Description Default value

Session timeout

ADQM Control web interface session timeout (in seconds)

1800

Enable CSRF validation

Enables CSRF validation

Enabled

SSL configuration
NOTE

For details on how to configure and enable SSL for components of ADQM Control’s services, see the SSL encryption article.

Parameter Description Default value

[ADQM Control’s Backend] → Enable SSL

Enables SSL for the Backend component

Disabled

[ADQM Control’s ADQM Agent] → Enable SSL

Enables SSL for the Agents component

Disabled

[ADQM Control’s Alert Generator] → Enable SSL

Enables SSL for the Alert Generator component

Disabled

[ADQM Control’s Alert Receiver] → Enable SSL

Enables SSL for the Alert Receiver component

Disabled

[Alertmanager] → Enable SSL

Enables SSL for the Alertmanager component

Disabled

[ADQM Control Services] → Certificate file

Path to the server SSL certificate file for the Backend, Agents, Alert Generator, Alert Receiver components

/etc/adqmc/server.crt

[ADQM Control Services] → Private key file

Path to the file with the private key of the server SSL certificate for the Backend, Agents, Alert Generator, Alert Receiver components

/etc/adqmc/server.key

[ADQM Control Services] → Certificate authority file

Path to the file with the CA certificate for the Backend, Agents, Alert Generator, Alert Receiver components

/etc/adqmc/ca.crt

[Alertmanager] → Certificate file

Path to the server SSL certificate file for the Alertmanager component

/etc/admprom/alert-manager/server.crt

[Alertmanager] → Private key file

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

/etc/admprom/alert-manager/server.key

[Alertmanager] → Certificate authority file

Path to the file with the CA certificate for the Alertmanager component

/etc/admprom/alert-manager/ca.crt

Network configuration

 

Parameter Description Default value

Backend port

Port to access the ADQM Control web interface

5555

Alert Generator port

Port the alert generator listens on

5001

ADQM agent port

Port the Agents service listens on

5002

Alertmanager port

Port the alert manager listens on

9093

Alert Receiver port

Port the alert receiver listens on

12322

Connection settings

 

Parameter Description Default value

Backend connection pool size

Maximum number of connections to a PostgreSQL database of the Backend service

8

ADQM agent connection pool size

Maximum number of connections to a PostgreSQL database of the Agents service

8

Statement timeout

Timeout for queries and transactions (in seconds)

120

Cleanup timeout

Server timeout (in seconds): abort any database query that runs longer than the specified time

86400

Migration timeout

Database migration timeout (in seconds)

3600

Prometheus timeout

Prometheus connection timeout (in seconds)

60

Alertmanager timeout

Alertmanager connection timeout (in seconds)

60

Polling rate

 

Parameter Description Default value

Hosts scrape interval

Frequency of updating information about the ADQM cluster topology (in seconds)

80

ADQMDB scrape interval

Frequency of updating information about tables in the ADQM cluster (in seconds)

80

Query update interval

Frequency of collecting queries (in seconds)

105

Query normalize interval

Frequency of updating queries (in seconds)

120

Check query_log interval

Frequency of checking query_log (in seconds)

60

Limits

 

Parameter Description Default value

Normalize query raw max queries per iteration

Maximum number of queries normalized per iteration

50000

Collect queries limit

Number of queries collected from the query_log per iteration

10000

Query normalize threshold

Number of attempts to normalize a query

10

Existing tables tries

Number of attempts to get metrics of an ADQM table. If ADQM Control has failed to retrieve the metrics for a table after the expiration of the time ADQMDB scrape interval * Existing tables tries, it considers this table deleted

3

Tables cache size

Size of the table cache

32768

Table cache invalidate interval

Time interval of the table cache invalidation (in seconds)

28800

Maximum revision per table in cache

Maximum number of revisions per table in the cache

100

Queries cache size

Size of the query cache

8192

Batch size of queries normalization

Query batch size for normalization

1024

Capacity of existing tables cache

Capacity of the existing tables cache

500000000

Existing tables cache invalidate period

Period of the existing table cache invalidation (in seconds)

604800

Table’s existing period for existing tables cache calculation

Period of a table’s existence (in seconds) for the existing table cache calculation

7776000

Maximum of parallel workers

Maximum number of parallel workers

0

Internal PostgreSQL server
NOTE

To access the configuration parameters, activate the Use internal PostgreSQL server option.

Parameter Description Default value

Alerts dbname

Name of a database to be created for use by ADQM Control services

adqmc

Alertsdb username

Name of a user with access to the Alerts dbname database

adqmc

Alertsdb password

Password for the Alertsdb username user to access the Alerts dbname database (should have a minimum length of 8 characters and should not contain ", , ', or \)

 — 

External PostgreSQL server
NOTE

To access the configuration parameters, activate the Use external PostgreSQL server option.

Parameter Description Default value

server_ip_port

Click Add property to specify an IP address (as property name) and port (as property value) to access an external PostgreSQL server

 — 

Alerts dbname

Database name to be used by ADQM Control services

adqmc

Alertsdb username

Name of a user with access to the Alerts dbname database

adqmc

Alertsdb password

Password for the Alertsdb username user to access the Alerts dbname database (should have a minimum length of 8 characters and should not contain ", , ', or \)

 — 

SSL is used by an external server

Specifies whether SSL is used by an external server

Disabled

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