PostgreSQL

The PostgreSQL integration requires CXDOT Collector 1.4.0 or greater. PostgreSQL is an open source object-relational database system. Use the PostgreSQL CXDOT Collector integration with the CXDOT Collector to collect connection and workload metrics from PostgreSQL servers running in your environment.

​

Supported telemetry types

The integration supports these telemetry types:

​

Prerequisites

The integration has the following prerequisites:

• Create a PostgreSQL role that can authenticate with a password and connect to the postgres database and every non-template database on each target.
• To collect ANALYZE progress metrics (postgresql.analyze.*, PostgreSQL 13 and later) for operations run by other roles, grant the monitoring role the predefined pg_monitor role. Grant pg_monitor only when you need that metric family; it can read privileged server statistics.
• Make each PostgreSQL endpoint reachable from the CXDOT Collector.

​

Configure

The integration is enabled by default. To configure the integration, follow these steps:

1. For discovered PostgreSQL targets, provide the endpoint and credentials for each instance through autodiscovery annotations. Metrics from discovered pods arrive with that pod’s Kubernetes metadata attached. For more information, see autodiscovery and enrichment.
2. Optional: Configure static targets instead of discovered targets, such as PostgreSQL servers outside your Kubernetes cluster, and provide the password through your deployment’s secret management. For example, add the following to the values.yaml for your Helm chart:
   config:
     integrations:
       postgres:
         instances:
           - endpoint: postgres.example.com:5432
         username: cxdot
         password: "${env:POSTGRES_PASSWORD}"
   
   When you configure static targets, this integration instance collects from exactly those targets instead of discovered targets.
3. Optional: Disable the integration. For example, add the following to the values.yaml for your Helm chart:
   config:
     integrations:
       postgres:
         enabled: false
   

​

Validate

To validate the integration, follow these steps:

1. In the Live Telemetry Analyzer, filter for __name__=cxdot.integration.target.health and cxdot.integration.name=postgres. Confirm that each reachable target reports 1 for cxdot.integration.target.health, identified by its server.address and server.port attributes.
2. In Metrics Explorer, run the following query while clients are connected to the PostgreSQL servers:
   sum by ("server.address", "server.port") ({"postgresql.backends"})
   
   Confirm that the query returns the expected time series for each target.

For more information about diagnosing a failing integration, see Troubleshooting.

​

Configuration reference

Configure one PostgreSQL integration instance with the following settings. In Helm values, place these settings under config.integrations.postgres. In a Collector configuration file, place them under cxdot.integrations.postgres.

​

Optional settings

• enabled Type: boolean. Optional. Default: true. Whether to enable this PostgreSQL integration instance. If true, the Collector collects PostgreSQL metrics. If false, the Collector doesn’t run this integration instance.
• username Type: string. Optional. Default: postgres. PostgreSQL user for connections to every statically configured instance.
• password Type: string. Optional. PostgreSQL password for connections to every statically configured instance. The Collector requires it to start collecting from instances entries, and masks the value in diagnostic output, logs, and errors.
• collection_interval Type: duration. Optional. Default: 10s. How often the integration collects metrics from each PostgreSQL instance.
• timeout Type: duration. Optional. Default: 10s. Maximum time allowed to collect metrics from a PostgreSQL instance during one interval. A value of 0s disables the timeout.
• instances Type: array of object. Optional. Default: []. PostgreSQL instances to monitor. Each endpoint uses host:port format, such as postgres.default.svc:5432. When this list contains an instance, the integration monitors only the listed instances and disables discovery through annotations for this integration instance. When the list is empty, the integration monitors targets supplied through PostgreSQL annotations. Each discovered target uses the credentials and TLS settings in its annotation.
• instances[].endpoint Type: string. Required. Network address of the PostgreSQL instance in host:port format.
• tls Type: object. Optional. Transport Layer Security (TLS) settings for connections to statically configured instances. By default, the integration uses TLS and verifies the server certificate. Set insecure_skip_verify to true to use TLS without verifying the certificate. Set insecure to true to connect without TLS. Targets discovered through annotations use the TLS settings in their annotations instead.
• tls.insecure Type: boolean. Optional. In gRPC and HTTP when set to true, this is used to disable the client transport security. See https://godoc.org/google.golang.org/grpc#WithInsecure for gRPC. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional, default false)
• tls.insecure_skip_verify Type: boolean. Optional. InsecureSkipVerify will enable TLS but not verify the certificate.