14 Plugins

Aperçu

Les plugins offrent une option pour étendre les capacités de surveillance de Zabbix. Les plugins sont écrits en langage de programmation Go et ne sont pris en charge que par l'agent Zabbix 2.

Les plugins fournissent une alternative aux modules chargeables (écrits en C) et à d'autres méthodes pour étendre les fonctionnalités de Zabbix, telles que les paramètres utilisateur (métriques de l'agent), les vérifications externes (surveillance sans agent) et l'élément d'agent Zabbix system.run[].

Les fonctionnalités suivantes sont spécifiques à l'agent Zabbix 2 et à ses plugins :

• prise en charge d'intervalles programmés et flexibles pour les contrôles passifs et actifs ;
• gestion de la file d'attente des tâches en ce qui concerne le calendrier et la simultanéité des tâches ;
• délais d'attente au niveau du plugin ;
• vérification de la compatibilité de l'agent Zabbix 2 et de son plugin au démarrage.

Depuis Zabbix 6.0.0, les plugins n'ont pas besoin d'être intégrés directement dans l'agent 2 et peuvent être ajoutés en tant que plugins chargeables, facilitant ainsi le processus de création de plugins supplémentaires pour collecter de nouvelles métriques de surveillance.

Cette page répertorie les plugins natifs et chargeables de Zabbix et décrit les principes de configuration des plugins du point de vue de l'utilisateur. Pour obtenir des instructions sur l'écriture de vos propres plugins, veuillez consulter les Directives de développement de plugins.

Configuration des plugins

Cette section fournit des principes de configuration de plug-in communs et les meilleures pratiques.

Tous les plugins sont configurés à l'aide du paramètre Plugins.*, qui peut soit faire partie du fichier de configuration de l'agent Zabbix 2 ou de leur propre fichier de configuration de plugin. Si un plugin utilise un fichier de configuration séparé, le chemin d'accès à ce fichier doit être spécifié dans le paramètre Include du fichier de configuration de l'agent Zabbix 2.

Chaque paramètre de plugin doit avoir la structure suivante :

Plugins.<PluginName>.<Parameter>=<Value>

Les noms de paramètres doivent respecter les exigences suivantes :

• il est recommandé de mettre en majuscules les noms de vos plugins ;
• le paramètre doit être en majuscule ;
• les caractères spéciaux ne sont pas autorisés;
• l'imbrication n'est pas limitée par un niveau maximum ;
• le nombre de paramètres n'est pas limité.

Sessions nommées

Les sessions nommées représentent un niveau supplémentaire de paramètres de plug-in et peuvent être utilisées pour définir des ensembles distincts de paramètres d'authentification pour chacune des instances surveillées. Chaque paramètre de session nommé doit avoir la structure suivante :

Plugins.<PluginName>.<SessionName>.<Parameter>=<Value>

Un nom de session peut être utilisé comme paramètre de clé d'élément connString au lieu de spécifier un URI, un nom d'utilisateur et un mot de passe séparément. Dans les clés d'élément, le premier paramètre peut être soit une connString soit un Uri. Si le premier paramètre clé correspond à un nom de session spécifié dans le fichier de configuration, la vérification sera exécutée à l'aide des paramètres de session nommés. Si le premier paramètre clé ne correspond à aucun nom de session, il sera traité comme un Uri.

Notez que:

• lors de la fourniture d'une connString (nom de session) dans les paramètres de clé, les paramètres de clé pour le nom d'utilisateur et le mot de passe doivent être vides ;
• la transmission des informations d'identification URI intégrées n'est pas prise en charge, envisagez d'utiliser des sessions nommées à la place ;
• dans le cas où un paramètre d'authentification n'est pas spécifié pour la session nommée, une valeur par défaut codée en dur sera utilisée.

La liste des paramètres de session nommée disponibles dépend du plugin, voir les fichiers de configuration du plugin individuel pour plus de détails.

Exemple : La surveillance de deux instances "MySQL1" et "MySQL2" peut être configurée de la manière suivante :

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=<UsernameForMySQL1>
       Plugins.Mysql.Sessions.MySQL1.Password=<PasswordForMySQL1>    
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://127.0.0.1:3307   
       Plugins.Mysql.Sessions.MySQL2.User=<UsernameForMySQL2>
       Plugins.Mysql.Sessions.MySQL2.Password=<PasswordForMySQL2>

Désormais, ces noms peuvent être utilisés comme connStrings dans les clés au lieu d'URIs :

mysql.ping[MySQL1]
       mysql.ping[MySQL2]

Parameter priority

Since version 6.4.3, Zabbix agent 2 plugins search for connection-related parameter values in the following order:

1. The first item key parameter is compared to session names. If no match is found it is treated as an actual value; in this case, step 3 will be skipped. If a match is found, the parameter value (usually, a URI) must be defined in the named session.
2. Other parameters will be taken from the item key if defined.
3. If an item key parameter (for example, password) is empty, plugin will look for the corresponding named session parameter.
4. If the session parameter is also not specified, the value defined in the corresponding default parameter will be used.
5. If all else fails, the plugin will use the hardcoded default value.

Example 1

Monitoring of two instances “MySQL1” and “MySQL2”.

Configuration parameters:

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
       Plugins.Mysql.Sessions.MySQL1.Password=unique_password
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=different_password

Item keys: mysql.ping[MySQL1], mysql.ping[MySQL2]

Example 2

Providing some of the parameters in the item key (supported since Zabbix 6.0.17).

Configuration parameters:

Plugins.Postgres.Sessions.Session1.Uri=tcp://192.0.2.234:5432
       Plugins.Postgres.Sessions.Session1.User=old_username
       Plugins.Postgres.Sessions.Session1.Password=session_password

Item key: pgsql.ping[session1,new_username,,postgres]

As a result of this configuration, the agent will connect to PostgreSQL using the following parameters:

• URI from session parameter: 192.0.2.234:5432
• Username from the item key: new_username
• Password from session parameter (since it is omitted in the item key): session_password
• Database name from the item key: postgres

Example 3

Collecting a metric using default configuration parameters.

Configuration parameters:

Plugins.Postgres.Default.Uri=tcp://192.0.2.234:5432
       Plugins.Postgres.Default.User=zabbix
       Plugins.Postgres.Default.Password=password

Item key: pgsql.ping[,,,postgres]

As a result of this configuration, the agent will connect to PostgreSQL using the parameters:

• Default URI: 192.0.2.234:5432
• Default username: zabbix
• Default password: password
• Database name from the item key: postgres

Valeurs par défaut codées en dur

Si un paramètre requis pour l'authentification n'est pas fourni dans une clé d'élément ou dans les paramètres de session nommés, le plugin utilisera une valeur par défaut codée en dur.

Connexions

Certains plugins prennent en charge la collecte de métriques à partir de plusieurs instances simultanément. Les instances locales et distantes peuvent être surveillées. Les connexions TCP et socket Unix sont prises en charge.

Il est recommandé de configurer les plugins pour maintenir les connexions aux instances dans un état ouvert. Les avantages sont une réduction de la congestion du réseau, de la latence et de l'utilisation du processeur et de la mémoire en raison du nombre inférieur de connexions. La bibliothèque cliente s'en charge.

Plugins

Toutes les métriques prises en charge par l'agent Zabbix 2 sont collectées par les plugins.

Intégrés

Les plugins suivants pour l'agent Zabbix 2 sont disponibles prêts à l'emploi. Cliquez sur le nom du plugin pour accéder au référentiel de plugins avec des informations supplémentaires.

Chargeable

Cliquez sur le nom du plugin pour accéder au référentiel de plugins avec des informations supplémentaires.

Voir aussi : Construire des plugins chargeables.

Notes de bas de page

¹ - Depuis Zabbix 6.0.13, les plugins chargeables ont commencé à utiliser le même système de gestion des versions que Zabbix lui-même. En conséquence, la version du plugin MongoDB est passée de 1.2.1 à 6.0.13.