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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for postgres_connection_exporter-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9ea4050eeff6622929b779330b8771388ad262adc1f163cb837f4ecfefcb55c |
|
MD5 | 137f238aadf3847a25369a707d648f2f |
|
BLAKE2b-256 | bcf1abdbcd44d3e56cbec531ae9d8dd1932342096145107e1e6ade5e5bf66bea |
Hashes for postgres_connection_exporter-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f0d896230c747f4bbbacc3748e731d4b9ed148ade2651fe034427ce9ba87c01 |
|
MD5 | 546700a4371c9708b115f7c5f6359bf9 |
|
BLAKE2b-256 | a7dee60263d9c59ea8a52d2d6a64de5721889bd908314b3612c536cff915340a |