Skip to main content

A Prometheus exporter for PostgreSQL connection metrics

Project description

PostgreSQL Connection Exporter for Prometheus

This is a simple server that exports PostgreSQL connection metrics in a format that can be scraped by Prometheus.

It outputs the following metrics:

  • The number of connections per database
  • The number of connections per user
  • The number of connections per client address
  • The number of connections per state

Installation

You can install the exporter from PyPI. Within a virtual environment, run:

pip install postgres-connection-exporter

Configuration

The exporter is configured using a config.yaml. You can create a default configuration file in the current working directory with:

postgres-connection-exporter --create-config

Now, edit the config.yaml file to match your PostgreSQL connection settings. Here is an example configuration:

hosts:
  host: localhost
  port: 5432
  user: postgres
  password: postgres

The user must have the pg_monitor role to access the pg_stat_activity view.

Usage

After you have created your config.yaml, you can start the exporter with:

postgres-connection-exporter

By default, the exporter listens on localhost:8989. You can change the address in the config.yaml file, or using the --host and --port flags:

postgres-connection-exporter --host 0.0.0.0 --port 9898

You can also specify a different configuration file with the --config flag:

postgres-connection-exporter --config /path/to/config.yaml

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postgres_connection_exporter-0.0.2.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page