Configuration parameters
This article describes the parameters that can be configured for ADPG services via ADCM. To read about the configuring process, refer to the relevant article Configure services.
NOTE
Some of the parameters become visible in the ADCM UI after the Show advanced flag being set.
|
ADPG
Parameter | Description | Default value |
---|---|---|
Data directory |
Directories that are used to store data on the ADPG hosts |
/pg_data1 |
Sysctl parameters
This section describes Linux kernel parameters. To add a new parameter, click the child node Add property of the Sysctl parameters [key:value] option.
In the window that appears, specify the parameter name and value and click Apply.
You can add multiple parameters.
External Etcd cluster
ADPG uses etcd as the Patroni Distributed Configuration Store (DCS). If you use an external etcd cluster, switch on the corresponding toggle button, expand the External Etcd [ip_address:port] node, and click Add property.
In the window that appears, specify the IP address of the etcd server in the first row and the port in the second row.
You can add multiple external etcd servers.
Enable PgBouncer
To use PgBouncer, switch on the Enable PgBouncer toggle button. When this toggle button is enabled, you can expand the corresponding node and specify settings listed in the table below.
Parameter name | Description | Default value |
---|---|---|
listen_port |
The port that PgBouncer listens on. This port cannot be changed for a running cluster. Execute the Reconfigure & Restart action to apply changes |
15432 |
pool_mode |
Specifies when a server connection can be reused by other clients. It can contain the following values:
|
session |
max_client_conn |
The maximum number of client connections allowed |
100 |
default_pool_size |
The number of connections to the server that are allowed for each user/database pair |
20 |
min_pool_size |
The minimum number of connections to the server to keep in the pool |
0 |
reserve_pool_size |
The number of additional connections allowed to the pool if a client connection exceeds the time specified in the |
0 |
reserve_pool_timeout |
If a client needs to wait longer than the specified time in seconds, additional connections from |
5 |
max_db_connections |
The maximum number of connections to a server for a database |
0 |
max_user_connections |
The maximum number of connections to a server for a user |
0 |
Enable all users |
When enabled, this option allows access to all users with password authentication. If the option is disabled, utilize |
Enabled |
Users list |
List of users who are allowed to access ADPG using PgBouncer, when the |
Empty |
Enable all databases |
When enabled, this option allows access to all existing databases with PgBouncer. If the option is disabled, utilize |
|
Databases list |
List of databases that are allowed to access using PgBouncer when the |
Empty |
Use custom pg_hba.conf |
When disabled, the general PG_HBA section of the ADPG service will be used for PgBouncer. If the option is enabled, it is necessary to add required settings to Custom pg_hba.conf. In this case, PgBouncer will use settings from Custom pg_hba.conf |
Disabled |
Custom pg_hba.conf |
Custom pg_hba.conf section for PgBouncer |
Empty |
After you specify required settings, click Save and execute the Reconfigure & Restart action to apply changes.
To make PgBouncer monitoring work correctly, call the cluster action Reconfigure monitoring agents after changing settings from the Enable pgbouncer configuration section.
Patroni ADPG configurations
This section describes Patroni configuration settings that can be changed in ADCM UI. For more information on these settings, refer to ADPG High Availability overview.
Parameter name | Description | Default value |
---|---|---|
synchronous_mode |
Enables Patroni synchronous mode |
false |
synchronous_node_count |
Specifies the number of synchronous standby nodes. The parameter value should not be more than the count of hosts with the ADPG component of the ADPG service installed on. This parameter is ignored if |
1 |
synchronous_mode_strict |
Prevents Patroni from switching off the synchronous replication on the primary when no synchronous standby candidates are available. Enables |
false |
maximum_lag_on_failover |
Specifies the amount of transactions in bytes that can be lost |
1048576 |
ttl |
The TTL to acquire the leader lock (in seconds). It defines the length of time before initiation of the automatic failover process |
30 |
loop_wait |
The time that Patroni waits (sleeps) before starting a new loop iteration (in seconds) |
10 |
retry_timeout |
The timeout for DCS and PostgreSQL operation retries (in seconds). DCS or network issues shorter than this value do not cause Patroni to demote the leader |
10 |
patroni_listen_port |
The port that Patroni listens to for the REST API. Can only be changed before the ADPG service installation |
8008 |
use_custom_location |
When enabled, you can specify custom logging settings for Patroni. The parameter requires to execute the Reconfigure & Restart action to apply changes |
false |
patroni_log_dir |
An existing folder to store Patroni logs. The parameter only has an effect if |
/var/log/adpg14/patroni |
patroni_log_file_size |
The size limit of a single Patroni log file, in bytes. The parameter only has an effect if |
25000000 |
patroni_log_file_num |
The number of log files to retain. The parameter only has an effect if |
4 |
patroni_log_level |
The level of logging. It can contain the following values: |
info |
ADPG configurations
The ADPG configurations section allows you to specify parameters from the postgresql.conf file (the default path is /pg_data1/adpg14/postgresql.conf). Use ADCM to set these parameters. When the ADPG service executes the Reconfigure & Restart or Reconfigure & Reload action, postgresql.conf is rewritten with settings specified on the Primary configuration tab of the ADPG service. If you make changes directly to postgresql.conf, these changes will be lost.
After modifying ADPG configuration parameters listed below, execute the Reconfigure & Reload or Reconfigure & Restart action to apply changes.
Parameter name | Description | Default value |
---|---|---|
port |
The TCP port the server listens on. Execute the Reconfigure & Restart action to apply changes |
5432 |
max_connections |
Determines the maximum number of concurrent connections to the server. For a replica host, the value of this parameter must be greater than or equal to the value on the leader host. If this requirement is not met, the replica host will reject all requests. Execute the Reconfigure & Restart action to apply changes |
100 |
shared_buffers |
Sets the amount of memory the server used for the shared memory buffer. The higher the value of this parameter, the less the load on the host hard drives will be. Execute the Reconfigure & Restart action to apply changes |
128 MB |
max_worker_processes |
Sets the maximum number of background processes that the system can support. Execute the Reconfigure & Restart action to apply changes |
8 |
max_parallel_workers |
Sets the maximum number of workers that the system can support for parallel operations. Execute the Reconfigure & Restart action to apply changes |
8 |
max_parallel_workers_per_gather |
Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. Execute the Reconfigure & Restart action to apply changes |
2 |
max_parallel_maintenance_workers |
Sets the maximum number of parallel workers that can be started by a single utility command. Execute the Reconfigure & Restart action to apply changes |
2 |
effective_cache_size |
Tells the ADPG query scheduler what RAM limit is available for caching data for the |
4096 MB |
maintenance_work_mem |
Sets the memory limit for maintenance operations. Increasing the value for this parameter can lead to faster operations for cleaning and restoring the database from the copy |
64 MB |
work_mem |
Sets the non-shared memory limit that is 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 |
4 MB |
min_wal_size |
Until WAL disk usage stays below the |
80 MB |
max_wal_size |
Sets the 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 |
1024 MB |
wal_keep_size |
Sets 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 the sending server falls behind by more than |
0 MB |
huge_pages |
Defines whether huge pages can be requested for the main shared memory area. The following values are valid:
|
try |
superuser_reserved_connections |
Determines the number of connection "slots" that are reserved for PostgreSQL superuser connections. Execute the Reconfigure & Restart action to apply changes |
3 |
logging_collector |
Enables the logging collector. The logging collector is a background process that captures log messages sent to stderr and redirects them into log files. Execute the Reconfigure & Restart action to apply changes |
The logging collector is enabled ( |
log_directory |
Determines the directory that contains log files. It can be specified as an absolute path, or relative to the cluster data directory |
log |
log_filename |
Specifies the log file name pattern. The 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 |
Determines the 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 |
1d |
log_rotation_size |
Determines the 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 |
0 |
log_min_messages |
Specifies the minimum severity level of messages that are written to a log file. Valid values are |
warning |
log_min_error_statement |
Specifies which SQL statements that cause errors are logged. Valid values are |
error |
postgresql.conf custom section
You can use postgresql.conf custom section to set additional parameters that are written to the postgresql.conf file. To add parameters, switch on the corresponding toggle button, expand the postgresql.conf [key:value] node and click Add properties node.
In the window that appears, specify the parameter name and value and click Apply.
You can add multiple parameters.
Parameters from postgresql.conf custom section have lower priority than other parameters. ADCM does not validate these parameters. Changes in the postgresql.conf file is reverted if the Start action of the ADPG service fails.
PG_HBA
The section allows you to add lines to the pg_hba.conf file. The pg_hba.conf file configures the client authentication.
Balancer
Parameter | Description | Default value |
---|---|---|
leader as replica |
Specifies if the leader handles read only transactions |
False |
leader_port |
Sets a port on the host with the HAProxy component for write transactions |
6432 |
replica_port |
Specifies a port on the host with the HAProxy component for read only transactions |
6433 |
balancer_stats_port |
Defines a port on which a web page with a HAProxy statistics report is available |
7000 |
pgbouncer_leader_port |
All connections to this port are transferred to a PgBouncer instance of an ADPG leader node |
16432 |
pgbouncer_replica_port |
All connections to this port are transferred to PgBouncer instances of ADPG replica nodes |
16433 |
Chrony
Parameter | Description | Default value |
---|---|---|
NTP servers |
Addresses of valid NTP servers. For example, |
— |
Etcd
IMPORTANT
The Etcd configuration settings cannot be changed after installation.
|
Parameter | Description | Default value |
---|---|---|
listen_peer_urls_port |
Specifies the port for peer communication |
2380 |
listen_client_urls_port |
Specifies the port for client requests |
2379 |
Metrics storage
Parameter | Description | Default value |
---|---|---|
Monitoring db name |
Defines a database name that the Metrics storage service should use |
adpg_metrics |
Monitoring username |
Specifies a username to connect to an ADPG monitoring cluster |
adpg_metrics_sender |
Monitoring user’s password |
Specifies a password, which the |
— |
Grafana TCP port |
Defines a TCP port on which Grafana listens for connections |
12012 |
Grafana admin’s password |
Specifies a password for the |
— |