Plugin PostgreSQL

Vue d'ensemble

Les paramètres de configuration permettent de personnaliser le comportement du plugin PostgreSQL.

Il est recommandé de les spécifier dans leur propre fichier de configuration (par exemple postgresql.conf), plutôt que dans le fichier de configuration de l'agent 2. Utilisez ensuite la directive Include pour inclure ce fichier dans la configuration de Zabbix agent 2.

Le plugin PostgreSQL est un plugin chargeable et est disponible, avec une description complète, dans le dépôt du plugin PostgreSQL.

Tous les paramètres sont facultatifs, sauf indication explicite précisant que le paramètre est obligatoire.

Cette page est structurée comme suit :

  • Vue d'ensemble des paramètres (pour afficher les détails complets d'un paramètre, cliquez sur son nom)
  • Détails des paramètres
Parameter Description
Plugins.PostgreSQL.CallTimeout Définit le temps d'attente maximal, en secondes, pour qu'une requête soit exécutée.
Plugins.PostgreSQL.CustomQueriesPath Spécifie le chemin complet du répertoire contenant les fichiers .sql avec des requêtes personnalisées.
Plugins.PostgreSQL.CustomQueriesEnabled Active l'exécution de la clé d'élément postgresql.custom.query.
Plugins.PostgreSQL.Default.CacheMode Spécifie le mode de cache par défaut pour la connexion PostgreSQL.
Plugins.PostgreSQL.Default.Database Spécifie le nom de base de données par défaut.
Plugins.PostgreSQL.Default.Password Spécifie le mot de passe par défaut.
Plugins.PostgreSQL.Default.TLSCAFile Spécifie le chemin complet du fichier contenant le ou les certificats de l'AC racine pour la vérification du certificat du pair.
Plugins.PostgreSQL.Default.TLSCertFile Spécifie le chemin complet du fichier contenant le certificat PostgreSQL ou la chaîne de certificats.
Plugins.PostgreSQL.Default.TLSConnect Spécifie le niveau de chiffrement par défaut pour les communications entre Zabbix agent 2 et les bases de données surveillées.
Plugins.PostgreSQL.Default.TLSKeyFile Spécifie le chemin complet du fichier contenant la clé privée PostgreSQL.
Plugins.PostgreSQL.Default.Uri Spécifie l'URI par défaut.
Plugins.PostgreSQL.Default.User Spécifie le nom d'utilisateur par défaut.
Plugins.PostgreSQL.KeepAlive Définit le temps d'attente maximal, en secondes, avant la fermeture des connexions inutilisées du plugin.
Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode Spécifie le mode de cache de la session nommée pour la connexion PostgreSQL.
Plugins.PostgreSQL.Sessions.<SessionName>.Database Spécifie le nom de base de données de la session nommée.
Plugins.PostgreSQL.Sessions.<SessionName>.Password Spécifie le mot de passe de la session nommée.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile Spécifie le chemin complet du fichier contenant le ou les certificats de l'AC racine pour la vérification du certificat du pair.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile Spécifie le chemin complet du fichier contenant le certificat PostgreSQL ou la chaîne de certificats.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect Spécifie le niveau de chiffrement de la session nommée pour les communications entre Zabbix agent 2 et les bases de données surveillées.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile Spécifie le chemin complet du fichier contenant la clé privée PostgreSQL.
Plugins.PostgreSQL.Sessions.<SessionName>.Uri Spécifie l'URI de la session nommée.
Plugins.PostgreSQL.Sessions.<SessionName>.User Spécifie le nom d'utilisateur de la session nommée.

|Plugins.PostgreSQL.System.Path|Spécifie le chemin vers l'exécutable du plugin PostgreSQL.| |Plugins.PostgreSQL.Timeout|Définit le délai d'expiration d'exécution de la requête.|

Notez que :

  • Les valeurs par défaut reflètent les valeurs par défaut du processus, et non celles des fichiers de configuration fournis.
  • Les valeurs prennent en charge les variables d'environnement ;
  • Zabbix prend en charge les fichiers de configuration uniquement au format UTF-8 sans BOM.
  • Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.

Détails du paramètre

Plugins.PostgreSQL.CallTimeout

Définit le temps d'attente maximal, en secondes, pour qu'une requête soit exécutée.

Par défaut: global timeout
Plage: 1-30

Plugins.PostgreSQL.CustomQueriesPath

Spécifiez le chemin complet du répertoire contenant les fichiers .sql avec des requêtes personnalisées.

Valeurs par défaut :
/usr/local/share/zabbix/custom-queries/postgreSQL - pour les systèmes Unix,
*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL - pour les systèmes Windows (où * est le nom du lecteur provenant de la variable d'environnement ProgramFiles)

Exemple :

/etc/zabbix/oracle/sql
Plugins.PostgreSQL.CustomQueriesEnabled

Active l'exécution de la clé d'élément postgresql.custom.query.
Si cette option est désactivée, aucune requête ne sera chargée depuis le chemin du répertoire des requêtes personnalisées.

Par défaut: false
Plage: true/false

Plugins.PostgreSQL.Default.CacheMode

Spécifie le mode de cache par défaut pour la connexion PostgreSQL.

Par défaut: prepare
Plage:
prepare - crée des instructions préparées sur le serveur PostgreSQL;
describe - utilise l'instruction préparée anonyme pour décrire une instruction sans en créer une sur le serveur.

Notez que describe est principalement utile lorsque l'environnement n'autorise pas les instructions préparées, par exemple lors de l'utilisation d'un pooler de connexions comme PgBouncer.

Plugins.PostgreSQL.Default.Database

Spécifiez la base de données par défaut pour la connexion à PostgreSQL.
Utilisée si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Plugins.PostgreSQL.Default.Password

Spécifiez le mot de passe par défaut pour la connexion à PostgreSQL.
Utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Plugins.PostgreSQL.Default.TLSCAFile

Spécifiez le chemin complet du fichier contenant le certificat de l'autorité de certification (CA) de niveau supérieur pour la vérification du certificat du pair lors des communications chiffrées entre Zabbix agent 2 et les bases de données surveillées.
Utilisé si aucune valeur n'est spécifiée dans une session nommée.

Obligatoire: yes, si Plugins.PostgreSQL.Default.TLSConnect est défini sur verify_ca ou verify_full

Plugins.PostgreSQL.Default.TLSCertFile

Spécifiez le chemin complet du fichier contenant le certificat PostgreSQL ou la chaîne de certificats pour les communications chiffrées entre l'agent Zabbix 2 et les bases de données surveillées.
Utilisé si aucune valeur n'est spécifiée dans une session nommée.

Obligatoire: yes, si Plugins.PostgreSQL.Default.TLSKeyFile est spécifié

Plugins.PostgreSQL.Default.TLSConnect

Spécifie le niveau de chiffrement par défaut pour les communications entre Zabbix agent 2 et les bases de données surveillées.
Utilisé si aucune valeur n'est spécifiée dans une session nommée.

Plage :
required - se connecter en utilisant TLS comme mode de transport sans vérification d'identité ;
verify_ca - se connecter en utilisant TLS et vérifier le certificat ;
verify_full - se connecter en utilisant TLS, vérifier le certificat et vérifier que l'identité de la base de données (CN) spécifiée par DBHost correspond à son certificat.

Un type de chiffrement non défini signifie une connexion non chiffrée.

Plugins.PostgreSQL.Default.TLSKeyFile

Spécifiez le chemin d'accès complet du fichier contenant la clé privée PostgreSQL pour les communications chiffrées entre l'agent 2 Zabbix et les bases de données surveillées.
Utilisé si aucune valeur n'est spécifiée dans une session nommée.

Obligatoire: yes, si Plugins.PostgreSQL.Default.TLSCertFile est spécifié

Plugins.PostgreSQL.Default.Uri

Spécifiez l'URI par défaut pour la connexion à PostgreSQL.
Utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.
Les identifiants intégrés seront ignorés.
Doit correspondre au format URI.
Schémas pris en charge: tcp, unix

Exemples:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User

Spécifiez le nom d'utilisateur par défaut pour la connexion à PostgreSQL.
Utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Plugins.PostgreSQL.KeepAlive

Définissez le temps d'attente maximal (en secondes) avant que les connexions de plugin inutilisées ne soient fermées.

Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode

Spécifiez le mode de cache de session nommé pour la connexion PostgreSQL.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Par défaut: prepare
Plage:
prepare - crée des instructions préparées sur le serveur PostgreSQL;
describe - utilise l'instruction préparée anonyme pour décrire une instruction sans en créer une sur le serveur.

Notez que describe est principalement utile lorsque l'environnement n'autorise pas les instructions préparées, par exemple lors de l'utilisation d'un pooler de connexions comme PgBouncer.

Plugins.PostgreSQL.Sessions.<SessionName>.Database

Spécifiez la base de données de session nommée pour la connexion à PostgreSQL.
<SessionName> - définissez le nom d'une session à utiliser dans les clés d'élément.

Plugins.PostgreSQL.Sessions.<SessionName>.Password

Spécifiez le mot de passe de la session nommée pour la connexion à PostgreSQL.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Doit correspondre au format du mot de passe.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile

Spécifiez le chemin d'accès complet du fichier contenant le ou les certificats CA racine pour la vérification du certificat du pair lors des communications chiffrées entre l'agent Zabbix 2 et les bases de données surveillées.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Obligatoire: yes, si Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect est défini sur verify_ca ou verify_full

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile

Spécifiez le chemin complet du fichier contenant le certificat PostgreSQL ou la chaîne de certificats pour les communications chiffrées entre l'agent Zabbix 2 et les bases de données surveillées.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Obligatoire : yes, si Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile est spécifié

Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect

Spécifie le niveau de chiffrement nommé de la session pour les communications entre l'agent Zabbix 2 et les bases de données surveillées.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Plage :
required - se connecter en utilisant TLS comme mode de transport sans vérification d'identité ;
verify_ca - se connecter en utilisant TLS et vérifier le certificat ;
verify_full - se connecter en utilisant TLS, vérifier le certificat et vérifier que l'identité de la base de données (CN) spécifiée par DBHost correspond à son certificat.

Un type de chiffrement non défini signifie une connexion non chiffrée.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile

Spécifiez le chemin d'accès complet du fichier contenant la clé privée PostgreSQL pour les communications chiffrées entre l'agent Zabbix 2 et les bases de données surveillées.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Obligatoire: yes, si Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile est spécifié.

Plugins.PostgreSQL.Sessions.<SessionName>.Uri

Spécifiez l'URI de session nommée pour la connexion à PostgreSQL.
<SessionName> - définissez le nom d'une session à utiliser dans les clés d'élément.
Les identifiants intégrés seront ignorés.
Doit correspondre au format URI.
Schémas pris en charge: tcp, unix

Exemples:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User

Spécifiez le nom d'utilisateur de la session nommée pour la connexion à PostgreSQL.
<SessionName> - définissez le nom d'une session à utiliser dans les clés d'élément.

Plugins.PostgreSQL.System.Path

Spécifiez le chemin vers l'exécutable du plugin PostgreSQL.

Obligatoire: yes

Exemple:

Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout

Définissez le délai d'exécution de la requête (la durée, en secondes, d'attente avant d'interrompre une requête si elle ne se termine pas).

Par défaut: global timeout
Plage: 1-30

Options

Parameter Description
-V --version Afficher la version du plugin et les informations de licence.
-h --help Afficher les informations d'aide (raccourci).
-t, --test <item key> Lancer le plugin pour les tests (la configuration du plugin est ignorée).

Voir aussi