Plugin MySQL

Vue d'ensemble

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

Il est recommandé de les spécifier dans leur propre fichier de configuration (par exemple mysql.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.

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

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 en encodage UTF-8, sans BOM ;
  • Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.

Parameter details

Plugins.Mysql.CallTimeout

Specify the maximum amount of time in seconds to wait for a request to be done.

Default: default timeout Range: 1-30

Plugins.Mysql.CustomQueriesPath

Specify full pathname of the directory containing .sql files with custom queries.

Defaults:
/usr/local/share/zabbix/custom-queries/mysql - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\Mysql - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Plugins.Mysql.CustomQueriesEnabled

Enable execution of the mysql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false Range: true/false

Plugins.Mysql.Default.Password

Specify the default password for a protected MySQL server.

Plugins.Mysql.Default.TLSConnect

Specify the default level of encryption for communications between Zabbix agent 2 and monitored databases.

Range:
required - require TLS connection;
verify_ca - verify certificates;
verify_full - verify certificates and IP address

Plugins.Mysql.Default.TLSCAFile

Specify full pathname of the file containing top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix agent 2 and monitored databases.

Mandatory: yes, if Plugins.Mysql.Default.TLSConnect is set to verify_ca or verify_full

Plugins.Mysql.Default.TLSCertFile

Specify full pathname of the file containing the agent certificate or certificate chain, used for encrypted communications between Zabbix agent 2 and monitored databases.

Mandatory: yes, if Plugins.Mysql.Default.TLSKeyFile is specified

Plugins.Mysql.Default.TLSKeyFile

Specify full pathname of the file containing the database private key, used for encrypted communications between Zabbix agent 2 and monitored databases.

Mandatory: yes, if Plugins.Mysql.Default.TLSCertFile is specified

Plugins.Mysql.Default.Uri

Specify the default URI for connecting to MySQL server.
Embedded credentials will be ignored.
Supported schemes: tcp, unix
The schema can be omitted.
The port can be omitted (default=3306).

Examples:

tcp://localhost:3306
localhost
unix:/var/run/mysql.sock
Plugins.Mysql.Default.User

Specify the default username for a protected MySQL server.

Plugins.Mysql.KeepAlive

Specify the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.Mysql.Sessions.<SessionName>.Password

Specify the named session password for a protected MySQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.Mysql.Sessions.<SessionName>.TLSConnect

Specify the level of named-session encryption for communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Range:
required - require TLS connection;
verify_ca - verify certificates;
verify_full - verify certificates and IP address

Plugins.Mysql.Sessions.<SessionName>.TLSCAFile

Specify full pathname of the file containing top-level CA(s) certificates for named-session peer certificate verification, used for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.Mysql.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full

Plugins.Mysql.Sessions.<SessionName>.TLSCertFile

Specify full pathname of the file containing the named-session agent certificate or certificate chain, used for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.Mysql.Sessions.<SessionName>.TLSKeyFile is specified

Plugins.Mysql.Sessions.<SessionName>.TLSKeyFile

Specify full pathname of the file containing the named-session database private key, used for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.Mysql.Sessions.<SessionName>.TLSCertFile is specified

Plugins.Mysql.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to MySQL server.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
Supported schemes: tcp, unix
The schema can be omitted.
The port can be omitted (default=3306).

Examples:

tcp://localhost:3306
localhost
unix:/var/run/mysql.sock
Plugins.Mysql.Sessions.<SessionName>.User

Specify the named session username for a protected MySQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.Mysql.Timeout

Set the maximum time in seconds for waiting when a connection has to be established.

Default: default timeout Range: 1-30

Paramètres

Parameter Mandatory Range Default Description
Plugins.Mysql.CallTimeout no 1-30 global timeout Temps maximal, en secondes, d'attente avant l'exécution d'une requête.
Plugins.Mysql.CustomQueriesPath no /usr/local/share/zabbix/custom-queries/mysql pour les systèmes Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\Mysql pour les systèmes Windows, où * est le nom du lecteur provenant de la variable d'environnement ProgramFiles
Chemin complet d'un répertoire contenant des fichiers .sql avec des requêtes personnalisées.
Plugins.Mysql.CustomQueriesEnabled no false Si défini, active l'exécution de la clé d'élément mysql.custom.query. Si désactivé, aucune requête ne sera chargée depuis le chemin du répertoire des requêtes personnalisées.
Plugins.Mysql.Default.Password no Mot de passe par défaut pour la connexion à MySQL ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.
Plugins.Mysql.Default.TLSCAFile no
(yes, if Plugins.Mysql.Default.TLSConnect is set to verify_ca or verify_full)
Chemin complet d'un fichier contenant le ou les certificats CA de niveau supérieur pour la vérification du certificat du pair, pour les 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.
Plugins.Mysql.Default.TLSCertFile no
(yes, if Plugins.Mysql.Default.TLSConnect is set to verify_ca or verify_full)
Chemin complet d'un fichier contenant le certificat de l'agent ou la chaîne de certificats, pour les 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.
Plugins.Mysql.Default.TLSConnect no Type de chiffrement 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.

Valeurs prises en charge :
required - connexion TLS requise ;
verify_ca - vérifier les certificats ;
verify_full - vérifier les certificats et l'adresse IP.
Plugins.Mysql.Default.TLSKeyFile no
(yes, if Plugins.Mysql.Default.TLSConnect is set to verify_ca or verify_full)
Chemin complet d'un fichier contenant la clé privée de la base de données pour les 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.
Plugins.Mysql.Default.Uri no tcp://localhost:3306 URI par défaut pour la connexion à MySQL ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Ne doit pas inclure d'identifiants intégrés (ils seront ignorés).
Doit correspondre au format URI.
Schémas pris en charge : tcp, unix ; un schéma peut être omis.
Un port peut être omis (par défaut=3306).
Exemples : tcp://localhost:3306
localhost
unix:/var/run/mysql.sock
Plugins.Mysql.Default.User no Nom d'utilisateur par défaut pour la connexion à MySQL ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.
Plugins.Mysql.KeepAlive no 60-900 300 Temps d'attente maximal, en secondes, avant la fermeture des connexions de plugin inutilisées.
Plugins.Mysql.Sessions.<SessionName>.Password no Mot de passe de la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.Mysql.Sessions.<SessionName>.TLSCAFile no
(yes, if Plugins.Mysql.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full)
Chemin complet d'un fichier contenant le ou les certificats CA de niveau supérieur pour la vérification du certificat du pair, utilisé pour les communications chiffrées entre Zabbix agent 2 et les bases de données surveillées.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.Mysql.Sessions.<SessionName>.TLSCertFile yes, if Plugins.Mysql.Sessions.<SessionName>.TLSKeyFile is specified Chemin complet d'un fichier contenant le certificat de l'agent ou la chaîne de certificats, utilisé pour les communications chiffrées entre Zabbix agent 2 et les bases de données surveillées.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.Mysql.Sessions.<SessionName>.TLSConnect no Type de chiffrement pour les communications entre Zabbix agent 2 et les bases de données surveillées.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.

Valeurs prises en charge :
required - connexion TLS requise ;
verify_ca - vérifier les certificats ;
verify_full - vérifier les certificats et l'adresse IP.
Plugins.Mysql.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.Mysql.Sessions.<SessionName>.TLSCertFile is specified Chemin complet d'un fichier contenant la clé privée de la base de données utilisée pour les communications chiffrées entre Zabbix agent 2 et les bases de données surveillées.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.Mysql.Sessions.<SessionName>.Uri no Chaîne de connexion d'une session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.

Ne doit pas inclure d'identifiants intégrés (ils seront ignorés).
Doit correspondre au format URI.
Schémas pris en charge : tcp, unix ; un schéma peut être omis.
Un port peut être omis (par défaut=3306).
Exemples : tcp://localhost:3306
localhost
unix:/var/run/mysql.sock
Plugins.Mysql.Sessions.<SessionName>.User no Nom d'utilisateur de la session nommée.
<SessionName> - définir le nom d'une session à utiliser dans les clés d'élément.
Plugins.Mysql.Timeout no 1-30 global timeout Temps maximal, en secondes, d'attente lors de l'établissement d'une connexion.

Voir aussi :