Paramètres de configuration: Zabbix agent 2

Vue d'ensemble

Les paramètres de configuration permettent de personnaliser le comportement de Zabbix agent 2.

Zabbix agent 2 est une nouvelle génération de Zabbix agent et peut être utilisé à la place de Zabbix agent.

Spécifiez les valeurs des paramètres dans le fichier de configuration (zabbix_agent2.conf). Tous les paramètres sont facultatifs, sauf indication explicite que le paramètre est obligatoire.

Cette page est structurée comme suit :

• Vue d'ensemble des paramètres (pour voir les détails complets d'un paramètre, cliquez sur son nom)
• Détails des paramètres

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.

Détails du paramètre

Alias

Définissez un alias pour une clé d'élément. Il peut être utilisé pour remplacer une clé d'élément longue et complexe par une clé plus courte et plus simple.
Plusieurs paramètres Alias peuvent être présents. Plusieurs paramètres avec la même clé Alias ne sont pas autorisés.
Différentes clés Alias peuvent faire référence à la même clé d'élément.
Les alias peuvent être utilisés dans HostMetadataItem mais pas dans le paramètre HostnameItem.

Exemple 1: Récupération de l'ID de l'utilisateur 'zabbix'.

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

Désormais, la clé abrégée zabbix.userid peut être utilisée pour récupérer des données.

Exemple 2: Obtention de l'utilisation CPU avec des paramètres par défaut et personnalisés.

Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]

Cela permet d'utiliser la clé cpu.util pour obtenir le pourcentage d'utilisation CPU avec les paramètres par défaut, ainsi que cpu.util[all, idle, avg15] pour obtenir des données spécifiques sur l'utilisation CPU.

Exemple 3: Exécution de plusieurs règles de découverte à bas niveau traitant les mêmes éléments découverts.

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

Il est désormais possible de configurer plusieurs règles de découverte en utilisant vfs.fs.discovery avec des paramètres différents pour chaque règle, par exemple vfs.fs.discovery[foo], vfs.fs.discovery[bar], etc.

AllowKey

Autoriser l'exécution des clés d'élément qui correspondent à un modèle. Le modèle de clé est une expression générique qui prend en charge le caractère "*" pour correspondre à n'importe quel nombre de caractères.
Plusieurs règles de correspondance de clés peuvent être définies en combinaison avec DenyKey. Les paramètres sont traités un par un selon leur ordre d'apparition. Voir aussi: Restriction des vérifications de l'agent.

BufferSend

Définissez la fréquence d'envoi des valeurs du tampon vers le serveur/proxy Zabbix (en secondes).
Notez que si le tampon est plein, les données seront envoyées plus tôt.

Par défaut: 5
Plage: 1-3600

BufferSize

Définit le nombre maximal de valeurs dans le tampon mémoire.
L'agent enverra toutes les données collectées au serveur Zabbix ou au proxy si le tampon est plein. Ce paramètre ne doit être utilisé que si le tampon persistant est désactivé (EnablePersistentBuffer=0).

Par défaut: 1000
Plage: 2-65535

ControlSocket

Spécifiez le socket de contrôle pour envoyer des commandes d'exécution avec l'option -R.

Par défaut: /tmp/agent.sock

DebugLevel

Définissez le niveau de débogage :
0 - informations de base sur le démarrage et l'arrêt des processus Zabbix
1 - informations critiques ;
2 - informations d'erreur ;
3 - avertissements ;
4 - pour le débogage (génère beaucoup d'informations) ;
5 - débogage étendu (génère encore plus d'informations).

Par défaut : 3
Plage : 0-5

DenyKey

Interdire l'exécution des clés d'élément qui correspondent à un motif.
Le motif de clé est une expression générique qui prend en charge le caractère "*" pour correspondre à n'importe quel nombre de caractères.
Plusieurs règles de correspondance de clés peuvent être définies en combinaison avec AllowKey. Les paramètres sont traités un par un selon leur ordre d'apparition. Voir aussi: Restricting agent checks.

EnablePersistentBuffer

Activez l'utilisation du stockage persistant local pour les éléments actifs.
Si le stockage persistant est désactivé, le tampon mémoire sera utilisé.

Par défaut: 0
Valeurs: 0 - désactivé, 1 - activé

ForceActiveChecksOnStart

Effectue les vérifications actives immédiatement après le redémarrage pour la première configuration reçue.
Également disponible en tant que paramètre de configuration par plugin, par exemple : Plugins.Uptime.System.ForceActiveChecksOnStart=1

Par défaut : 0
Valeurs : 0 - désactivé, 1 - activé

HeartbeatFrequency

Définit la fréquence des messages de heartbeat en secondes.
Utilisé pour surveiller la disponibilité des vérifications actives.
0 - messages de heartbeat désactivés.

Par défaut: 60
Plage: 0-3600

HostInterface

Spécifiez l'interface de l'hôte (adresse IP ou nom DNS) utilisée lors de l'autoregistration de l'hôte.
Cette valeur sera utilisée pour renseigner l'interface dans le nouvel hôte créé, et permet de configurer explicitement une adresse IP ou DNS.
Pour plus de détails, voir Utiliser DNS comme interface par défaut.

Si elle n'est pas définie, la valeur sera obtenue à partir de HostInterfaceItem.

L'agent signalera une erreur et ne démarrera pas si la valeur dépasse la limite de 255 caractères.

Plage: 0-255 caractères

HostInterfaceItem

Spécifiez un élément pour déterminer l'interface de l'hôte (adresse IP ou nom DNS) lors de l'auto-enregistrement.
Cette valeur est utilisée uniquement si HostInterface n'est pas défini.
Pour plus de détails, consultez Utiliser DNS comme interface par défaut.

Lors d'une demande d'auto-enregistrement, l'agent consignera un message d'avertissement si la valeur renvoyée par l'élément spécifié dépasse la limite de 255 caractères.

L'élément system.run[] est pris en charge indépendamment des paramètres AllowKey/DenyKey.

HostMetadata

Spécifiez les métadonnées utilisées pour identifier ou distinguer l'hôte lors de l'autoregistration de l'hôte.
HostMetadata permet de distinguer les hôtes au-delà du nom d'hôte.

Si elle n'est pas définie, la valeur sera obtenue à partir de HostMetadataItem.

L'agent signalera une erreur et ne démarrera pas si la valeur spécifiée dépasse la limite de 2034 octets ou s'il s'agit d'une chaîne non UTF-8. Lorsqu'un paramètre attend une adresse IP ou un nom DNS, les valeurs valides en UTF-8 mais qui ne sont ni des IP valides ni des noms DNS valides seront également rejetées et signalées comme invalides.

Les métadonnées multilignes ne sont pas prises en charge — la sortie sera tronquée au premier saut de ligne.

Plage: 0-2034 octets

HostMetadataItem

Spécifiez un élément pour obtenir les métadonnées de l'hôte.
Cette option est utilisée uniquement lorsque HostMetadata n'est pas défini.

La valeur HostMetadataItem est récupérée à chaque tentative d'autoregistration et n'est utilisée que pendant le processus d'autoregistration de l'hôte. HostMetadataItem permet de distinguer les hôtes au-delà du nom d'hôte.

Les paramètres utilisateur et les alias sont pris en charge. L'élément system.run[] est pris en charge indépendamment des paramètres AllowKey/DenyKey.

Lors d'une demande d'autoregistration, l'agent consignera un message d'avertissement si la valeur renvoyée par l'élément spécifié dépasse la limite de 65535 points de code UTF-8. La valeur renvoyée par l'élément doit être une chaîne UTF-8, sinon elle sera ignorée. Lorsqu'un paramètre attend une adresse IP ou un nom DNS, les valeurs valides en UTF-8 mais qui ne sont pas des IP ou des noms DNS valides seront également rejetées et signalées comme invalides.

Les métadonnées multilignes ne sont pas prises en charge — la sortie sera tronquée au premier saut de ligne.

Nom d'hôte

Spécifiez des noms d'hôte uniques, sensibles à la casse. Une liste délimitée par des virgules.
Requis pour les vérifications actives et doit correspondre aux noms d'hôte tels qu'ils sont configurés sur le serveur.
La valeur est obtenue à partir de HostnameItem si elle n'est pas définie.
Caractères autorisés : alphanumériques, '.', ' ', '_' et '-'. Longueur maximale : 128 caractères par nom d'hôte, 2048 caractères pour l'ensemble de la ligne.

Par défaut : défini par HostnameItem

HostnameItem

Spécifiez un élément pour obtenir le nom d'hôte.
Cette option est utilisée uniquement lorsque Hostname n'est pas défini.
Les paramètres utilisateur ou les alias ne sont pas pris en charge, mais l'élément system.run[] est pris en charge indépendamment des valeurs AllowKey/DenyKey.

Par défaut: system.hostname

Inclure

Spécifiez un répertoire ou des fichiers individuels à inclure dans le fichier de configuration.
Pendant l'installation, Zabbix créera le répertoire d'inclusion dans /usr/local/etc, sauf modification lors de la compilation. Le chemin peut être relatif à l'emplacement du fichier zabbix_agent2.conf.
Pour n'inclure que les fichiers pertinents dans le répertoire spécifié, le caractère générique astérisque est pris en charge pour la correspondance de motifs.
Consultez notes spéciales concernant les limitations.

Exemple :

Include=/absolute/path/to/config/files/*.conf

ListenIP

Spécifiez l'adresse IP d'écoute de l'agent pour les connexions provenant du serveur/proxy. Il s'agit d'une liste séparée par des virgules.
La première adresse IP est envoyée au serveur Zabbix, si la connexion s'y effectue, afin de récupérer la liste des vérifications actives.

Par défaut: 0.0.0.0

ListenPort

Spécifiez le port d'écoute de l'agent pour les connexions provenant du serveur/proxy.

Par défaut: 10050
Plage: 1024-32767

LogFile

Spécifiez le fichier journal de l'agent.

Par défaut: /tmp/zabbix_agent2.log
Obligatoire: Oui, si LogType est défini sur file ; sinon non

LogFileSize

Définissez la taille maximale du fichier journal (en Mo).
0 - désactive la rotation automatique des journaux.
Remarque : si la limite de taille du fichier journal est atteinte et que la rotation du fichier échoue, quelle qu'en soit la raison, le fichier journal existant est tronqué et recréé.

Par défaut : 1
Plage : 0-1024

LogType

Spécifiez le type de sortie du journal :
file - écrit le journal dans le fichier spécifié par le paramètre LogFile;
system - écrit le journal dans syslog;
console - écrit le journal sur la sortie standard

Par défaut : file

PersistentBufferFile

Spécifiez le fichier pour conserver la base de données SQLite. Il doit s'agir d'un nom de fichier complet.
Ce paramètre est utilisé uniquement si le buffer persistant est activé (EnablePersistentBuffer=1).

PersistentBufferPeriod

Définit la période de conservation des données lorsqu'il n'y a pas de connexion au serveur Zabbix ou au proxy. Les données plus anciennes seront perdues.
Les données de journal seront conservées. Ce paramètre est utilisé uniquement si le tampon persistant est activé (EnablePersistentBuffer=1).

Par défaut: 1h
Plage: 1m-365d

PidFile

Spécifiez le fichier PID.

Par défaut : /tmp/zabbix_agent2.pid

Plugins.<PluginName>.System.Capacity

Définissez la limite de vérifications par plugin <PluginName> qui peuvent être exécutées en même temps.

Par défaut: 1000 Plage: 1-1000

Plugins.Log.MaxLinesPerSecond

Définit le nombre maximal de nouvelles lignes par seconde à envoyer au serveur/proxy Zabbix lors du traitement des vérifications actives log ou logrt.
La valeur fournie sera remplacée par le paramètre maxlines, fourni dans la clé d'élément log et logrt.
Remarque : Zabbix traitera 10 fois plus de nouvelles lignes que la valeur définie dans MaxLinesPerSecond afin de rechercher la chaîne requise dans les éléments de journal.

Par défaut : 20
Plage : 1-1000

Plugins.SystemRun.LogRemoteCommands

Active l'enregistrement des commandes shell exécutées en tant qu'avertissements.
Les commandes ne seront consignées que si elles sont exécutées à distance.
Aucune entrée de journal ne sera créée si system.run[] est lancé localement par les paramètres HostMetadataItem, HostInterfaceItem ou HostnameItem.

Par défaut: 0
Valeurs: 0 - désactivé, 1 - activé

PluginSocket

Spécifiez le chemin vers le socket UNIX pour les communications du plugin chargeable.

Par défaut : /tmp/agent.plugin.sock

PluginTimeout

Spécifie le délai d'attente pour les connexions aux plugins chargeables, en secondes.

Par défaut: Timeout
Plage: 1-30

RefreshActiveChecks

Spécifie la fréquence d'actualisation de la liste des vérifications actives, en secondes.
Notez qu'après un échec d'actualisation des vérifications actives, la prochaine tentative d'actualisation sera effectuée dans 60 secondes.

Par défaut: 5
Plage: 1-86400

Serveur

Spécifiez les adresses IP, éventuellement en notation CIDR, ou les noms DNS des serveurs/proxy Zabbix. Une liste séparée par des virgules.
Les connexions entrantes ne seront acceptées que depuis les hôtes répertoriés ici. Si la prise en charge d'IPv6 est activée, alors '127.0.0.1', '::127.0.0.1', '::ffff:127.0.0.1' sont traités de la même manière et '::/0' autorisera n'importe quelle adresse IPv4 ou IPv6. '0.0.0.0/0' peut être utilisé pour autoriser n'importe quelle adresse IPv4. Les espaces sont autorisés. Si ce paramètre n'est pas spécifié, les vérifications passives sont désactivées et l'agent n'écoutera sur aucun port TCP.

Exemple :

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

ServerActive

Spécifiez l'adresse du serveur/proxy Zabbix ou la configuration du cluster pour obtenir les vérifications actives.
L'adresse du serveur/proxy est une adresse IP ou un nom DNS, avec un port facultatif séparé par deux-points.
La configuration du cluster est constituée d'une ou plusieurs adresses de membres du groupe de serveurs ou de proxy séparées par des points-virgules. Plusieurs serveurs/clusters Zabbix et proxies Zabbix peuvent être spécifiés, séparés par des virgules. Sauf en cas d'utilisation de groupes de proxy, il ne faut pas spécifier plus d'un proxy Zabbix pour chaque serveur/cluster Zabbix. Si un proxy Zabbix est spécifié, alors le serveur/cluster Zabbix correspondant à ce proxy ne doit pas être spécifié.
Plusieurs adresses séparées par des virgules peuvent être fournies pour utiliser plusieurs serveurs Zabbix indépendants en parallèle. Les espaces sont autorisés.
Si le port n'est pas spécifié, le port par défaut est utilisé.
Les adresses IPv6 doivent être placées entre crochets si le port de cet hôte est spécifié. Si le port n'est pas spécifié, les crochets pour les adresses IPv6 sont facultatifs.
Si ce paramètre n'est pas spécifié, les vérifications actives sont désactivées.

Exemple pour un proxy Zabbix :

ServerActive=127.0.0.1:10051

Exemple pour un groupe de proxy Zabbix :

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

Exemple pour plusieurs serveurs :

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

Exemple pour la haute disponibilité :

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

Exemple pour la haute disponibilité avec deux clusters et un serveur :

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain

SourceIP

Spécifiez l'adresse IP source pour :

• les connexions sortantes vers le serveur Zabbix ou le proxy Zabbix.
• l'établissement de connexions lors de l'exécution de certains éléments (web.page.get, net.tcp.port, etc.).

StatusPort

Spécifiez le port d'écoute pour les requêtes d'état HTTP (http://localhost:<port>/status).

Plage : 1024-32767

Délai d'attente

Spécifiez combien de temps attendre (en secondes) pour établir la connexion et échanger des données avec le proxy ou le serveur Zabbix.

Ce paramètre définit la durée de diverses opérations de communication, notamment :

• l'attente d'une réponse du serveur Zabbix ;
• l'envoi de requêtes au serveur Zabbix, y compris les requêtes de configuration des éléments et les données des éléments dans les vérifications actives ;
• la récupération des données de journal via logfile ;
• l'envoi de messages de heartbeat ;
• la durée maximale des vérifications vfs.* ;
• le rôle de solution de repli dans les scénarios où un serveur ou un proxy antérieur à la version 7.0 envoie des vérifications sans délais d'attente.

Ce délai d'attente ne sera pas utilisé pour les vérifications d'agent qui disposent de paramètres de délai d'attente configurables dans l'interface (au niveau global, du proxy ou de chaque élément).

Par défaut : 3
Plage : 1-30

TLSAccept

Spécifiez le niveau de chiffrement requis pour les connexions entrantes.
Utilisé pour les vérifications passives.
Plusieurs valeurs peuvent être spécifiées, séparées par des virgules :
unencrypted - accepte les connexions sans chiffrement (par défaut)
psk - accepte les connexions avec TLS et une clé prépartagée (PSK)
cert - accepte les connexions avec TLS et un certificat

Obligatoire : oui, si les paramètres du certificat TLS ou de la PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCAFile

Spécifiez le chemin d'accès complet du fichier contenant les certificats de l'autorité de certification (CA) de niveau supérieur pour la vérification du certificat du pair, utilisé pour les communications chiffrées entre les composants Zabbix.

TLSCertFile

Spécifiez le chemin d'accès complet du fichier contenant le certificat de l'agent ou la chaîne de certificats, utilisé pour les communications chiffrées avec les composants Zabbix.

TLSCipherAll

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.2). Remplacez les critères de sélection de la suite de chiffrement par défaut pour le chiffrement basé sur les certificats et sur PSK.

Exemple :

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128

TLSCipherAll13

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.3) pour OpenSSL 1.1.1 ou une version plus récente. Remplacez les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur les certificats et sur PSK.

Exemple :

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.2). Remplacez les critères de sélection de la suite de chiffrement par défaut pour le chiffrement basé sur les certificats.

Exemple :

EECDH+aRSA+AES128:RSA+aRSA+AES128

Notez que ce paramètre ne peut pas être utilisé avec TLSAccept=cert,psk; pour une connexion par certificat (TLSConnect=cert), utilisez plutôt TLSCipherAll.

TLSCipherCert13

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.3) pour OpenSSL 1.1.1 ou une version plus récente. Remplacez les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur des certificats.

Notez que ce paramètre ne peut pas être utilisé avec TLSAccept=cert,psk; pour une connexion par certificat (TLSConnect=cert), utilisez plutôt TLSCipherAll13.

TLSCipherPSK

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.2). Remplacez les critères de sélection de la suite de chiffrement par défaut pour le chiffrement basé sur PSK.

Exemple :

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

Spécifiez la chaîne de chiffrement OpenSSL (TLS 1.3) pour OpenSSL 1.1.1 ou une version plus récente. Remplacez les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur PSK.

Exemple :

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

Spécifiez le niveau de chiffrement requis pour les connexions de l'agent au serveur Zabbix ou au proxy.
Utilisé pour les vérifications actives.
Une seule valeur peut être spécifiée :
unencrypted - se connecter sans chiffrement (par défaut)
psk - se connecter en utilisant TLS et une clé prépartagée (PSK)
cert - se connecter en utilisant TLS et un certificat

Obligatoire : oui, si les paramètres du certificat TLS ou de la PSK sont définis (même pour une connexion unencrypted) ; sinon non

TLSCRLFile

Spécifiez le chemin d'accès complet du fichier contenant les certificats révoqués. Ce paramètre est utilisé pour les communications chiffrées entre les composants Zabbix.

TLSKeyFile

Spécifiez le chemin d'accès complet du fichier contenant la clé privée de l'agent, utilisée pour les communications chiffrées entre les composants Zabbix.

TLSPSKFile

Spécifiez le chemin d'accès complet du fichier contenant la clé pré-partagée de l'agent, utilisée pour les communications chiffrées avec le serveur Zabbix.

TLSPSKIdentity

Spécifiez la chaîne d'identité de la clé pré-partagée, utilisée pour les communications chiffrées avec le serveur Zabbix.

TLSServerCertIssuer

Spécifiez l'émetteur du certificat du serveur (proxy) autorisé.

TLSServerCertSubject

Spécifiez le sujet de certificat autorisé du serveur (proxy).

UnsafeUserParameters

Autoriser tous les caractères à être transmis dans les arguments des paramètres définis par l'utilisateur. Les caractères suivants ne sont pas autorisés : \ ' " ` * ? [ ] { } \~ $ ! & ; ( ) < > | # @ %
De plus, les caractères de nouvelle ligne ne sont pas autorisés.

Par défaut : 0
Valeurs : 0 - ne pas autoriser, 1 - autoriser

UserParameter

Spécifiez un paramètre défini par l'utilisateur à surveiller. Il peut y avoir plusieurs paramètres définis par l'utilisateur.
Format : UserParameter=<key>,<shell command>
Notez que la commande shell ne doit pas renvoyer une chaîne vide ni uniquement un EOL. Les commandes shell peuvent utiliser des chemins relatifs si le paramètre UserParameterDir est spécifié.

Exemple :

UserParameter=system.test,who|wc -l
UserParameter=check_cpu,./custom_script.sh

UserParameterDir

Spécifie le chemin de recherche par défaut pour les commandes UserParameter. Si cette option est utilisée, l'agent change son répertoire de travail pour celui indiqué ici avant d'exécuter une commande. Ainsi, les commandes UserParameter peuvent utiliser un préfixe relatif ./ au lieu d'un chemin complet.
Une seule entrée est autorisée.

Exemple :

UserParameterDir=/opt/myscripts