Configuration parameters

ADQM username

Username to connect to ADQM

adqmc

ADQM user password

Password for the ADQM username user to connect to ADQM

 — 

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)

[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

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

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

Confd update interval

Time interval between checking for changes in the configuration files of services (in seconds)

30

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

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

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

 — 

server_ip_port

Click Add property to add the host and port properties that define an IP address and port 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 alerts db_username user to access the alerts_dbname database

 — 

SSL is used by an external server

Specifies whether SSL is used by an external server

Disabled

zk_type

Indicates which ZooKeeper cluster ADQM Control uses — internal (installed as the Zookeeper service of the ADQM Control cluster) or external. Possible values are Internal Zookeeper, External Zokeeper

Internal Zookeeper

zk_hosts

List of external Zookeeper cluster hosts (for example: host1.internal:2181,host2.internal:2181,host3.internal:2181). It is required if zk_type is set to External Zokeeper

 — 

zk_prefix

Prefix for all paths to znodes in ZooKeeper related to ADQM Control

/arenadata/adqm_control/<cluster_id>

SSL connection

Turns on secure connection to ZooKeeper

Disabled

listen_addresses

TCP/IP addresses on which the server listens for connections from client applications

*

port

TCP port the server listens on

5432

max_connections

Maximum number of concurrent connections to the database server

100

shared_buffers

Amount of memory the database server uses for shared memory buffer. A reasonable starting value is 25% of the memory in your system

2048 MB

max_worker_processes

Maximum number of background processes that the system can support

23

max_parallel_workers

Maximum number of workers that the system can support for parallel operations

4

max_parallel_workers_per_gather

Maximum number of workers that can be started by a single Gather or Gather Merge node

2

max_parallel_maintenance_workers

Maximum number of parallel workers that can be started by a single utility command

2

effective_cache_size

Sets the ADPG query planner’s assumption about the effective size of the disk cache available to a single query. This is factored into estimates of the cost of using an index. The higher this value, the more likely the index scan will be applied. The lower this value, the more likely the sequential scan will be selected

6144 MB

maintenance_work_mem

Memory limit for maintenance operations. Increasing the value for this parameter can improve the performance of operations for cleaning and restoring the database from a copy

1024 MB

work_mem

Non-shared memory limit used for internal operations when the server executes queries (for example, queries to temporary tables) before temporary files on the disk are used. This limit acts as simple resource control, preventing the host from going into swapping due to overallocation. Since the allocated memory is non-shared memory, large and complex requests can exceed the specified limit

5242 kB

min_wal_size

Until WAL disk usage stays below the min_wal_size value, old WAL files are recycled for future use at a checkpoint, rather than removed. This ensures that enough WAL space is reserved to handle spikes in WAL usage, for example, when running large batch jobs

1024 MB

max_wal_size

Memory limit to which the log size can grow between automatic checkpoints. Increasing this setting may increase the recovery time after a failure. The specified limit can be exceeded automatically with a high load on ADPG

4096 MB

wal_keep_size

Specifies the minimum size of segments retained in the pg_wal directory, in case a standby server needs to fetch them for streaming replication. If a standby server connected to a sending server falls behind by more than wal_keep_size MB, the sending server might remove a WAL segment still needed by the standby. In this case, the replication connection is terminated. Downstream connections also fail as a result. If WAL archiving is enabled, the standby server can fetch the segment from archive and recover. The wal_keep_size parameter sets only the minimum size of segments retained in pg_wal. The system might need to retain more segments for WAL archival or to recover from a checkpoint. If wal_keep_size is set to 0, the system does not keep any extra segments for standby purposes, so the number of old WAL segments available to standby servers depends on the location of the previous checkpoint and status of WAL archiving

0 MB

huge_pages

try

superuser_reserved_connections

Number of connection "slots" that are reserved for PostgreSQL superuser connections

3

timescaledb.max_background_workers

Maximum number of background worker processes allocated to TimescaleDB

16

wal_buffers

Amount of shared memory used for WAL data that has not yet been written to disk

16 MB

default_statistics_target

Default statistics target for table columns without a column-specific target set via ALTER TABLE…​SET STATISTICS

100

random_page_cost

Planner’s estimate of the cost of a non-sequentially-fetched disk page

1.1

checkpoint_completion_target

Target time of checkpoint completion as a fraction of total time between checkpoints

0.9

max_locks_per_transaction

The shared lock table tracks locks on max_locks_per_transaction * (max_connections + max_prepared_transactions) objects (for example, tables). Hence, no more than this number of distinct objects can be locked at any one time. This parameter controls the average number of object locks allocated for each transaction. Individual transactions can lock more objects as long as the locks of all transactions fit in the lock table

128

autovacuum_max_workers

Maximum number of autovacuum processes (excluding the autovacuum launcher) that are allowed to run at the same time

10

autovacuum_naptime(seconds)

Minimum delay between autovacuum runs on any given database. In each round, the autovacuum daemon examines the database and executes the VACUUM and ANALYZE commands if it is needed for tables in that database

10

default_toast_compression

Default TOAST compression method for values of a compressible column. Possible values: lz4, pglz

lz4

effective_io_concurrency

Number of concurrent disk I/O operations that can be executed simultaneously. Raising this value will increase the number of I/O operations that a PostgreSQL session attempts to initiate in parallel

256

jit

Specifies whether PostgreSQL may use JIT compilation, if it is available

off

logging_collector

Enables the logging collector — a background process that captures log messages sent to stderr and redirects them into log files

Enabled

log_directory

Directory that contains log files. It can be specified as an absolute path, or relative to the ADPG cluster data directory

log (the absolute path is /pg_data1/adpg14/log)

log_filename

Log file name pattern. A value can include strftime %-escapes to define time-varying file names. If you specify a file name pattern without escapes, use a log rotation utility to save disk space

postgresql-%a.log

log_rotation_age

Maximum period of time to use a log file, after which a new log file is created. If this value is specified without units, it is taken as minutes. Set log_rotation_age to 0 to disable time-based log file creation

1d

log_rotation_size

Maximum size of a log file. After a log file reaches the specified size, a new log file is created. If the value is set without units, it is taken as kilobytes. Set log_rotation_size to 0 to disable size-based log file creation

0

log_min_messages

Minimum severity level of messages to be written to a log file. Possible values are debug5, debug4, debug3, debug2, debug1, info, notice, warning, error, log, fatal, and panic (see the Severity levels table). Messages with the specified severity or higher are included in the log file. For example, if you set log_min_messages to warning, the log file will include the warning, error, log, fatal, and panic messages

warning

log_min_error_statement

Specifies which SQL statements that cause errors are logged. Possible values are debug5, debug4, debug3, debug2, debug1, info, notice, warning, error, log, fatal, and panic (see the Severity levels table). The log file includes SQL statements for messages of the specified severity or higher. To disable error statement logging, set log_min_error_statement to panic

error

Enable SSL

Enables SSL encryption of incoming traffic for the ADPG service

Disabled

Certificate file

Path to the server SSL certificate file

/etc/adpg16/server.crt

Private key file

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

/etc/adpg16/server.key

Certificate authority file

Path to the CA certificate file

/etc/adpg16/ca.crt

connect

ZooKeeper connection string used by other services or clusters. It is generated automatically

 — 

dataDir

Location where ZooKeeper stores the in-memory database snapshots and, unless specified otherwise, the transaction log of updates to the database. It is specified as the dataDir parameter in the zoo.cfg configuration file

/var/lib/zookeeper

clientPort

Port to listen for client connections, that is the port that clients attempt to connect to

2181

Port that the embedded Jetty server listens on

5181

Enables Admin server — an embedded Jetty server that provides an HTTP interface to the four-letter-word commands

Disabled

tickTime

Length of a single tick (in milliseconds) which is the basic time unit used by ZooKeeper to regulate heartbeats and timeouts

2000

initLimit

Amount of time (in ticks) to allow followers to connect and sync with a leader. Increase this value as needed if the amount of data managed by ZooKeeper is large

5

syncLimit

Amount of time (in ticks) to allow followers to sync with ZooKeeper. If followers fall too far behind a leader, they will be dropped

2

maxClientCnxns

Limits the number of active connections from a single client, identified by IP address, to a single member of the ZooKeeper ensemble

0

autopurge.snapRetainCount

When enabled, ZooKeeper auto-purge feature retains the specified number of the most recent snapshots and the corresponding transaction logs in dataDir and dataLogDir respectively, and deletes the rest. The minimum value is 3

3

autopurge.purgeInterval

Time interval (in hours), for which the purge task has to be triggered. Set a positive integer to enable the auto purging

24

Add key,value

In this section, you can define values for custom parameters that are not displayed in ADCM UI, but are allowed in the zoo.cfg configuration file

 — 

Enable SSL

Enables secure incoming connections in ZooKeeper

Disabled

sslQuorum

Enables encrypted quorum communication

Disabled

serverCnxnFactory

Specifies ServerCnxnFactory implementation. To use TLS-based server communication, set it to NettyServerCnxnFactory

org.apache.zookeeper.server.NettyServerCnxnFactory

ssl.quorum.keyStore.location

Fully-qualified path to the server keystore file

/etc/zookeeper/server.jks

ssl.quorum.keyStore.password

Password for the keystore specified in ssl.quorum.keyStore.location

 — 

ssl.quorum.trustStore.location

Fully-qualified path to the server truststore file

/etc/zookeeper/ca.jks

ssl.quorum.trustStore.password

Password for the truststore specified in ssl.quorum.trustStore.location

 — 

ssl.keyStore.location

Fully-qualified path to the server keystore file to be used for client TLS connections

/etc/zookeeper/server.jks

ssl.keyStore.password

Password for the keystore specified in ssl.keyStore.location

 — 

ssl.trustStore.location

Fully-qualified path to the server truststore file to be used for client TLS connections

/etc/zookeeper/ca.jks

ssl.trustStore.password

Password for the truststore specified in ssl.trustStore.location

 — 

ssl.protocol

Protocol to be used in client TLS negotiation

TLSv1.2

ssl.quorum.protocol

Protocol to be used in quorum TLS negotiation

TLSv1.2

secureClientPort

Port to be used for secure client connections

2281

Listen port

Port to listen for Zookeeper service metrics

9020

JAVA

Path to Java

$JAVA_HOME/bin/java

ZOOPIDFILE

Directory to store the ZooKeeper process ID

/var/run/zookeeper/zookeeper_server.pid

ZOO_LOG_DIR

Directory to store logs

/var/log/zookeeper

SERVER_JVMFLAGS

Used to set different JVM parameters (for example, parameters related to garbage collection)

-Xmx1024m

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

Password of a Grafana user to connect to Prometheus

 — 

Prometheus users to login/logout to Prometheus

User credentials for logging into the Prometheus web interface

 — 

Service parameters

Prometheus parameters

 — 

Grafana administrator’s password

Password of a Grafana administrator user

 — 

Grafana listen port

Port to access the Grafana web interface

11210

Listen port

Port to listen for a host’s system metrics in the Prometheus format

11203

Metrics endpoint

Endpoint to retrieve system metrics

/metrics

[Prometheus] → Enable SSL

Enables SSL encryption of incoming traffic for the Prometheus Server component

Disabled

[Prometheus] → Certificate file

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

/etc/admprom/prometheus/server.crt

[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

[Prometheus] → Certificate authority file

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

/etc/admprom/prometheus/ca.crt

[Grafana] → Enable SSL

Enables SSL encryption of incoming traffic for the Grafana component

Disabled

[Grafana] → Certificate file

Path to the server SSL certificate file for the Grafana component

/etc/admprom/grafana/server.crt

[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

[Grafana] → Certificate authority file

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

/etc/admprom/grafana/ca.crt

[Node-exporter] → Enable SSL

Enables SSL encryption of incoming traffic for the Node Exporter component

Disabled

[Node-exporter] → Certificate file

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

/etc/ssl/server.crt

[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