PGBouncer

Supported OS Linux Mac OS

Présentation

Le check PgBouncer surveille les métriques du pool de connexions et vous permet de mesurer le trafic entrant et sortant de votre application.

Configuration

Installation

Le check PgBouncer est inclus dans le paquet de l’Agent Datadog : vous n’avez donc rien d’autre à installer sur vos nœuds PgBouncer.

Ce check nécessite un utilisateur associé afin d’interroger votre instance PgBouncer :

Créez un utilisateur Datadog dans votre fichier pgbouncer.ini PgBouncer :
```
stats_users = datadog
```
Ajoutez un mot de passe associé pour l’utilisateur datadog dans votre fichier userlist.txt PgBouncer :
```
"datadog" "<PASSWORD>"
```

Pour vérifier les identifiants, exécutez la commande suivante :

psql -h localhost -U datadog -p 6432 pgbouncer -c \
"SHOW VERSION;" \
&& echo -e "\e[0;32mpgBouncer connection - OK\e[0m" \
|| echo -e "\e[0;31mCannot connect to pgBouncer\e[0m"

Une fois invité à saisir un mot de passe, indiquez celui que vous avez ajouté au fichier userlist.txt.

Configuration

Host

Pour configurer ce check lorsque l’Agent est exécuté sur un host :

Collecte de métriques

Modifiez le fichier pgbouncer.d/conf.yaml dans le dossier conf.d/ à la racine du répertoire de configuration de votre Agent. Consultez le fichier d’exemple pgbouncer.d/conf.yaml pour découvrir toutes les options de configuration disponibles :
```
init_config:

instances:
  ## @param database_url - string - required
  ## `database_url` parameter should point to PgBouncer stats database url (ie. "pgbouncer")
  #
  - database_url: "postgresql://datadog:<PASSWORD>@<HOSTNAME>:<PORT>/<DATABASE_URL>?sslmode=require"
```
Remarque : si votre instance de PgBouncer ne prend pas en charge la technologie SSL, remplacez sslmode=require par sslmode=allow pour éviter d’engendrer des erreurs de serveur. Pour en savoir plus sur la prise en charge de SSL, consultez la documentation de Postgres (en anglais).
Redémarrez l’Agent.

Collecte de logs

Disponible à partir des versions > 6.0 de l’Agent

La collecte de logs est désactivée par défaut dans l’Agent Datadog. Vous devez l’activer dans datadog.yaml :
```
logs_enabled: true
```
Ajoutez ce bloc de configuration à votre fichier pgbouncer.d/conf.yaml pour commencer à recueillir vos logs Pgbouncer :
```
logs:
  - type: file
    path: /var/log/postgresql/pgbouncer.log
    source: pgbouncer
    service: "<SERVICE_NAME>"
```
Modifiez les valeurs des paramètres path et service et configurez-les pour votre environnement. Consultez le fichier d’exemple pgbouncer.d/conf.yaml pour découvrir toutes les options de configuration disponibles.
Redémarrez l’Agent.

Environnement conteneurisé

Consultez la documentation relative aux modèles d’intégration Autodiscovery pour découvrir comment appliquer les paramètres ci-dessous à un environnement conteneurisé.

Collecte de métriques

Paramètre	Valeur
`<NOM_INTÉGRATION>`	`pgbouncer`
`<CONFIG_INIT>`	vide ou `{}`
`<CONFIG_INSTANCE>`	`{"database_url": "postgresql://datadog:<MOTDEPASSE>@%%host%%:%%port%%/<URL_BASEDEDONNÉES>?sslmode=require"}`

Collecte de logs

Disponible à partir des versions > 6.0 de l’Agent

La collecte des logs est désactivée par défaut dans l’Agent Datadog. Pour l’activer, consultez la section Collecte de logs avec Kubernetes.

Paramètre	Valeur
`<CONFIG_LOG>`	{“source”: “pgbouncer”, “service”: “pgbouncer”}

Validation

Lancez la sous-commande status de l’Agent et cherchez pgbouncer dans la section Checks.

Données collectées

Métriques

pgbouncer.clients.connect_time (gauge)	When the connection was made (seconds since epoch) Shown as second
pgbouncer.clients.request_time (gauge)	When last request was issued (seconds since epoch) Shown as second
pgbouncer.clients.wait (gauge)	Current waiting time in seconds Shown as second
pgbouncer.clients.wait_us (gauge)	The microsecond portion of the current waiting time Shown as microsecond
pgbouncer.databases.current_connections (gauge)	Current number of connections for this database Shown as connection
pgbouncer.databases.max_connections (gauge)	Maximum number of allowed connections Shown as connection
pgbouncer.databases.pool_size (gauge)	Maximum number of server connections Shown as connection
pgbouncer.max_client_conn (gauge)	The maximum number of client connections allowed. Shown as connection
pgbouncer.pools.cl_active (gauge)	Client connections linked to server connection and able to process queries Shown as connection
pgbouncer.pools.cl_waiting (gauge)	Client connections waiting on a server connection Shown as connection
pgbouncer.pools.maxwait (gauge)	How long the first (oldest) client in the queue has waited, in seconds Shown as second
pgbouncer.pools.maxwait_us (gauge)	Microsecond part of the maximum waiting time Shown as microsecond
pgbouncer.pools.sv_active (gauge)	Server connections linked to a client connection Shown as connection
pgbouncer.pools.sv_idle (gauge)	Server connections idle and ready for a client query Shown as connection
pgbouncer.pools.sv_login (gauge)	Server connections currently in the process of logging in Shown as connection
pgbouncer.pools.sv_tested (gauge)	Server connections currently running either serverresetquery or servercheckquery Shown as connection
pgbouncer.pools.sv_used (gauge)	Server connections idle more than servercheckdelay, needing servercheckquery Shown as connection
pgbouncer.servers.connect_time (gauge)	When the connection was made (seconds since epoch) Shown as second
pgbouncer.servers.request_time (gauge)	When last request was issued (seconds since epoch) Shown as second
pgbouncer.stats.avg_query (gauge)	The average query duration Shown as microsecond
pgbouncer.stats.avg_query_count (gauge)	The average number of queries per second in last stat period Shown as query
pgbouncer.stats.avg_query_time (gauge)	The average query duration Shown as microsecond
pgbouncer.stats.avg_recv (gauge)	The client network traffic received Shown as byte
pgbouncer.stats.avg_req (gauge)	The average number of requests per second in last stat period Shown as request
pgbouncer.stats.avg_sent (gauge)	The client network traffic sent Shown as byte
pgbouncer.stats.avg_transaction_count (gauge)	The average number of transactions per second in last stat period Shown as transaction
pgbouncer.stats.avg_transaction_time (gauge)	The average transaction duration Shown as microsecond
pgbouncer.stats.avg_wait_time (gauge)	Time spent by clients waiting for a server, in microseconds (average per second) Shown as microsecond
pgbouncer.stats.bytes_received_per_second (rate)	The total network traffic received Shown as byte
pgbouncer.stats.bytes_sent_per_second (rate)	The total network traffic sent Shown as byte
pgbouncer.stats.queries_per_second (rate)	The query rate Shown as query
pgbouncer.stats.requests_per_second (rate)	The request rate Shown as request
pgbouncer.stats.total_query_time (rate)	Time spent by pgbouncer actively querying PostgreSQL Shown as microsecond
pgbouncer.stats.total_transaction_time (rate)	Time spent by pgbouncer in transactions Shown as microsecond
pgbouncer.stats.total_wait_time (gauge)	Time spent by clients waiting for a server, in microseconds Shown as microsecond
pgbouncer.stats.transactions_per_second (rate)	The transaction rate Shown as transaction

Remarque : les métriques ne sont pas toutes disponibles pour toutes les versions de PgBouncer.

Événements

Le check PgBouncer n’inclut aucun événement.

Checks de service

Consultez le fichier service_checks.json pour afficher la liste des checks de service fournis par cette intégration.

Dépannage

Besoin d’aide ? Contactez l’assistance Datadog.