The PostgreSQL receiver is a component of the Splunk Distribution of the OpenTelemetry Collector. It collects metrics from PostgreSQL using the PostgreSQL statistics collector. The supported pipeline type is metrics.

Requirements

• Use PostgreSQL version 9.6 and higher.

• To let the receiver collect data, grant the monitoring user SELECT permissions for pg_stat_database. Learn more at the official PostgreSQL statistics collector documentation.

Deploy the collector

See Deploy the Splunk Distribution of the OpenTelemetry Collector.

Configure the receiver

1. In your OpenTelemetry configuration file, add postgresql to the receivers section:

   receivers:
     postgresql:
       endpoint: localhost:5432
       transport: tcp
       username: otel
       password: ${env:PGSQL_PASSWORD}
       databases:
         - otel
       collection_interval: 10s
       tls:
         insecure: false
         insecure_skip_verify: false
         ca_file: /home/otel/authorities.crt
         cert_file: /home/otel/mypostgrescert.crt
         key_file: /home/otel/mypostgreskey.key

   • username and password are mandatory.

   • endpoint is the address at which receiver searches for a PostgreSQL server. Its default value is localhost:5432. You can specify a different value here.

2. Add postgresql to the metrics pipeline:

   service:
     pipelines:
       metrics:
         receivers: [postgresql]

Restart the collector

To apply your configuration changes, restart the collector. The command to restart the Splunk Distribution of the OpenTelemetry Collector varies depending on what platform you deployed it on and what tool you used to deploy it, but here are general examples of the restart command:

• Linux with installer script:

  sudo systemctl restart splunk-otel-collector

• Windows with installer script:

  stop-service splunk-otel-collector
  start-service splunk-otel-collector

• Kubernetes with Helm:

  sudo systemctl restart splunk-otel-collector

Settings

The following table shows the configuration options for the PostgreSQL:

Metrics

The following metrics, resource attributes, and attributes are available.

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

Troubleshooting