https://github.com/prometheus-community/pgbouncer_exporter
Prometheus exporter for PgBouncer
https://github.com/prometheus-community/pgbouncer_exporter
Last synced: 20 days ago
JSON representation
Prometheus exporter for PgBouncer
- Host: GitHub
- URL: https://github.com/prometheus-community/pgbouncer_exporter
- Owner: prometheus-community
- License: mit
- Created: 2018-05-01T19:36:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T16:12:51.000Z (about 1 month ago)
- Last Synced: 2025-04-06T15:06:14.263Z (27 days ago)
- Language: Go
- Size: 3.38 MB
- Stars: 156
- Watchers: 7
- Forks: 58
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-repositories - prometheus-community/pgbouncer_exporter - Prometheus exporter for PgBouncer (Go)
README
# PgBouncer exporter
[](https://circleci.com/gh/prometheus-community/pgbouncer_exporter)
Prometheus exporter for PgBouncer.
Exports metrics at `9127/metrics`
## Building and running
make build
./pgbouncer_exporter
To see all available configuration flags:
./pgbouncer_exporter -h
## PGBouncer configuration
The pgbouncer\_exporter requires a configuration change to pgbouncer to ignore a PostgreSQL driver connection parameter. In the `pgbouncer.ini` please include this option:
ignore_startup_parameters = extra_float_digits
## Run with docker
```
docker run prometheuscommunity/pgbouncer-exporter
```
## Metrics
|PgBouncer column|Prometheus Metric|Description|
|----------------|-----------------|-----------|
stats_total_query_count | pgbouncer_stats_queries_pooled_total | Total number of SQL queries pooled
stats.total_query_time | pgbouncer_stats_queries_duration_seconds_total | Total number of seconds spent by pgbouncer when actively connected to PostgreSQL, executing queries
stats.total_received | pgbouncer_stats_received_bytes_total | Total volume in bytes of network traffic received by pgbouncer, shown as bytes
stats.total_requests | pgbouncer_stats_queries_total | Total number of SQL requests pooled by pgbouncer, shown as requests
stats.total_sent | pgbouncer_stats_sent_bytes_total | Total volume in bytes of network traffic sent by pgbouncer, shown as bytes
stats.total_wait_time | pgbouncer_stats_client_wait_seconds_total | Time spent by clients waiting for a server in seconds
stats.total_xact_count | pgbouncer_stats_sql_transactions_pooled_total | Total number of SQL transactions pooled
stats.total_xact_time | pgbouncer_stats_server_in_transaction_seconds_total | Total number of seconds spent by pgbouncer when connected to PostgreSQL in a transaction, either idle in transaction or executing queries
pools.cl_active | pgbouncer_pools_client_active_connections | Client connections linked to server connection and able to process queries, shown as connection
pools.cl_waiting | pgbouncer_pools_client_waiting_connections | Client connections waiting on a server connection, shown as connection
pools.sv_active | pgbouncer_pools_server_active_connections | Server connections linked to a client connection, shown as connection
pools.sv_idle | pgbouncer_pools_server_idle_connections | Server connections idle and ready for a client query, shown as connection
pools.sv_used | pgbouncer_pools_server_used_connections | Server connections idle more than server_check_delay, needing server_check_query, shown as connection
pools.sv_tested | pgbouncer_pools_server_testing_connections | Server connections currently running either server_reset_query or server_check_query, shown as connection
pools.sv_login | pgbouncer_pools_server_login_connections | Server connections currently in the process of logging in, shown as connection
pools.maxwait | pgbouncer_pools_client_maxwait_seconds | Age of oldest unserved client connection, shown as second
config.max_client_conn | pgbouncer_config_max_client_connections | Configured maximum number of client connections
config.max_user_connections | pgbouncer_config_max_user_connections | Configured maximum number of server connections per user
## TLS and basic authentication
The pgbouncer exporter supports TLS and basic authentication.
To use TLS and/or basic authentication, you need to pass a configuration file
using the `--web.config.file` parameter. The format of the file is described
[in the exporter-toolkit repository](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md).