Skip to content
PERCONA MONITORING AND MANAGEMENT DOCUMENTATION

For help, click the link below to get free database assistance or contact our experts for personalized support.

Get help from Percona

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_TEST_HA_ENABLE Enable PMM to run in High Availability (HA) mode.
PMM_TEST_HA_BOOTSTRAP Bootstrap HA cluster.
PMM_TEST_HA_NODE_ID HA Node ID.
PMM_TEST_HA_ADVERTISE_ADDRESS HA Advertise address.
PMM_TEST_HA_GOSSIP_PORT HA gossip port.
PMM_TEST_HA_RAFT_PORT HA raft port.
PMM_TEST_HA_GRAFANA_GOSSIP_PORT HA Grafana gossip port.
PMM_TEST_HA_PEERS HA Peers.

Available preview variables

Variable Description
PERCONA_TEST_SAAS_HOST SaaS server hostname.
PMM_CLICKHOUSE_ADDR Name of the 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

Using preview variables

Add preview variables to your docker run command for testing purposes:

docker run -d \
  --name pmm-server \
  -e PERCONA_TEST_PMM_CLICKHOUSE_ADDR=clickhouse-test:9000 \
  -e PERCONA_TEST_PMM_CLICKHOUSE_DATABASE=pmm_test \
  percona/pmm-server:3

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.