Preview environment variables

Warning

The PERCONA_TEST_* environment variables are experimental and subject to change. These variables are intended for testing purposes only and should not be used in production environments.

For stable, production-ready configuration options, see the main Environment variables for PMM Server documentation.

Variable	Description
PMM_HA_ENABLE	Enable PMM to run in High Availability (HA) mode.
PMM_HA_NODE_ID	HA Node ID.
PMM_HA_ADVERTISE_ADDRESS	HA Advertise address.
PMM_HA_GOSSIP_PORT	HA gossip port.
PMM_HA_RAFT_PORT	HA raft port.
PMM_HA_GRAFANA_GOSSIP_PORT	HA Grafana gossip port.
PMM_HA_PEERS	HA Peers.

All HA nodes must share one encryption key

HA nodes share one PostgreSQL database, but each node reads its encryption key from its own /srv/pmm-encryption.key. A node that generated its own key cannot decrypt the credentials stored by the other nodes, and the services those credentials belong to stop being monitored.

Generate the key once with pmm-encryption-rotation --generate-key, place it at /srv/pmm-encryption.key on every node, and only then start them. With PMM_HA_ENABLE set, a node without a key file refuses to start rather than generating one of its own.

See PMM data encryption for details.

Available preview variables

Variable	Description
PMM_CLICKHOUSE_ADDR	Host and port of the external ClickHouse database instance
PMM_CLICKHOUSE_DATABASE	Database name of the external ClickHouse instance
​​PMM_CLICKHOUSE_USER	Database user
PMM_CLICKHOUSE_PASSWORD	Database user password

Testing external ClickHouse connections

The ClickHouse-related preview variables are useful for testing PMM Server with an external ClickHouse instance:

1. Set up a test ClickHouse instance.
2. Configure the connection using the variables above.
3. Launch PMM Server and verify it connects and stores metrics correctly.
4. Monitor logs to validate how metrics display.