Step 4: Configure the Collector

Configuring the collector with Docker

Create your configuration file (e.g. named pganalyze_collector.env) with environment variables like this:

PGA_API_KEY=your-organization-api-key
DB_HOST=your_db.postgres.database.azure.com
DB_NAME=your_database_name
DB_USERNAME=your_monitoring_user
DB_PASSWORD=your_monitoring_user_password
AZURE_SUBSCRIPTION_ID=your_subscription_id
# AZURE_DB_SERVER_NAME=your_azure_server_resource_name

Fill in the values step-by-step:

1. The PGA_API_KEY can be found in the pganalyze Settings page for your organization, under the API Access tab
2. The DB_HOST is the hostname of your Azure Database for PostgreSQL instance, e.g. your_db.postgres.database.azure.com
3. The DB_NAME is the database on the Azure Database for PostgreSQL instance you want to monitor
4. The DB_USERNAME and DB_PASSWORD should be the credentials of the monitoring user we created in Step 1
5. The AZURE_SUBSCRIPTION_ID is the subscription ID of your Azure Database server
6. (optional) The AZURE_DB_SERVER_NAME is the exact name of your Azure Database server resource, as shown in the Azure Portal. It is inferred from a DB_HOST like <server name>.postgres.database.azure.com, so leave it out in that case. Set it if DB_HOST is an IP address or a custom DNS record, or if you’re using Azure Cosmos DB for PostgreSQL Cluster, where it is the name of your cluster.

If the VM has multiple Managed Identities assigned, specify the client ID of the specific Managed Identity created in Step 3 using the AZURE_AD_CLIENT_ID setting.

Test snapshot

Then run the following:

docker run --env-file pganalyze_collector.env quay.io/pganalyze/collector:stable test

Once you’ve confirmed the install is successful and you’re receiving query data in pganalyze, we recommend setting up Log Insights as a follow-up step, to automatically track log events in your database.