Project: Netdata (Observability and Analysis / Observability)
File: pgbouncer.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pgbouncer/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pgbouncer/metadata.yaml" sidebar_label: "PgBouncer" learn_status: "Published" learnrelpath: "Collecting Metrics/Databases" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/postgres.svg" width="150"/> Plugin: go.d.plugin Module: pgbouncer <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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 . This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | pgbouncer.clientconnectionsutilization | used | percentage | These metrics refer to the database. Labels: | Label | Description | |:--|:-| | database | database name | | postgres_database | Postgres database name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | pgbouncer.dbclientconnections | active, waiting, cancel_req | connections | | pgbouncer.dbserverconnections | active, idle, used, tested, login | connections | | pgbouncer.dbserverconnections_utilization | used | percentage | | pgbouncer.dbclientswait_time | time | seconds | | pgbouncer.dbclientmaxwaittime | time | seconds | | pgbouncer.db_transactions | transactions | transactions/s | | pgbouncer.dbtransactionstime | time | seconds | | pgbouncer.dbtransactionavg_time | time | seconds | | pgbouncer.db_queries | queries | queries/s | | pgbouncer.dbqueriestime | time | seconds | | pgbouncer.dbqueryavg_time | time | seconds | | pgbouncer.dbnetworkio | received, sent | B/s | There are no alerts configured by default for this integration. Create a user with `stats_users` permissions to query your PgBouncer

To create the `netdata` user: Add `netdata` user to the `pgbouncer.ini` file: ```text stats_users = netdata ``` Add a password for the `netdata` user to the `userlist.txt` file: ```text "netdata" "<PASSWORD>" ``` To verify the credentials, run the following command ```bash psql -h localhost -U netdata -p 6432 pgbouncer -c "SHOW VERSION;" >/dev/null 2>&1 && echo OK || echo FAIL ``` When it prompts for a password, enter the password you added to `userlist.txt`. 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/pgbouncer.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | dsn | PgBouncer server DSN (Data Source Name). See . | postgres://postgres:postgres@127.0.0.1:6432/pgbouncer | yes | | timeout | Query timeout in seconds. | 1 | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local dsn: 'postgres://postgres:postgres@127.0.0.1:6432/pgbouncer' ``` </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local dsn: 'host=/tmp dbname=pgbouncer user=postgres port=6432' ``` </details> Note: When you define multiple jobs, their names must be unique. Local and remote instances. <details><summary>Config</summary> ```yaml 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' ``` </details> 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.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m pgbouncer ```