PgBouncer
PgBouncer
Plugin: go.d.plugin Module: pgbouncer
Overview
This collector monitors PgBouncer servers.
Executed queries:
SHOW VERSION;SHOW CONFIG;SHOW DATABASES;SHOW STATS;SHOW POOLS;
Information about the queries can be found in the PgBouncer Documentation.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
This integration doesn’t support auto-detection.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
Create netdata user
Create a user with stats_users permissions to query your PgBouncer instance.
To create the netdata user:
-
Add
netdatauser to thepgbouncer.inifile:stats_users = netdata -
Add a password for the
netdatauser to theuserlist.txtfile:"netdata" "<PASSWORD>" -
To verify the credentials, run the following command
psql -h localhost -U netdata -p 6432 pgbouncer -c "SHOW VERSION;" >/dev/null 2>&1 && echo OK || echo FAILWhen it prompts for a password, enter the password you added to
userlist.txt.
Configuration
File
The configuration file name for this integration is go.d/pgbouncer.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/pgbouncer.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 5 | False |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | False |
| dsn | PgBouncer server DSN (Data Source Name). See DSN syntax. | postgres://postgres:postgres@127.0.0.1:6432/pgbouncer | True |
| timeout | Query timeout in seconds. | 1 | False |
Examples
TCP socket
An example configuration.
jobs:
- name: local
dsn: 'postgres://postgres:postgres@127.0.0.1:6432/pgbouncer'
Unix socket
An example configuration.
jobs:
- name: local
dsn: 'host=/tmp dbname=pgbouncer user=postgres port=6432'
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Local and remote instances.
jobs:
- name: local
dsn: 'postgres://postgres:postgres@127.0.0.1:6432/pgbouncer'
- name: remote
dsn: 'postgres://postgres:postgres@203.0.113.10:6432/pgbouncer'
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per PgBouncer instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| pgbouncer.client_connections_utilization | used | percentage |
Per database
These metrics refer to the database.
Labels:
| Label | Description |
|---|---|
| database | database name |
| postgres_database | Postgres database name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| pgbouncer.db_client_connections | active, waiting, cancel_req | connections |
| pgbouncer.db_server_connections | active, idle, used, tested, login | connections |
| pgbouncer.db_server_connections_utilization | used | percentage |
| pgbouncer.db_clients_wait_time | time | seconds |
| pgbouncer.db_client_max_wait_time | time | seconds |
| pgbouncer.db_transactions | transactions | transactions/s |
| pgbouncer.db_transactions_time | time | seconds |
| pgbouncer.db_transaction_avg_time | time | seconds |
| pgbouncer.db_queries | queries | queries/s |
| pgbouncer.db_queries_time | time | seconds |
| pgbouncer.db_query_avg_time | time | seconds |
| pgbouncer.db_network_io | received, sent | B/s |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
To troubleshoot issues with the pgbouncer collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m pgbouncer