4 Zabbix agent 2 (UNIX)

Aperçu

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

Les paramètres pris en charge par le fichier de configuration de Zabbix agent 2 (zabbix_agent2.conf) sont répertoriés dans cette section.

Les paramètres sont listés sans informations supplémentaires. Cliquez sur un paramètre pour afficher tous les détails.

Tous les paramètres sont facultatifs, sauf indication explicite qu’un paramètre est obligatoire.

Notez que :

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

Détails des paramètres

Alias

Définit 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 référencer 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’identifiant de l’utilisateur « zabbix ».

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

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

Exemple 2 : Obtention de l’utilisation du processeur 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 du processeur avec les paramètres par défaut, ainsi que cpu.util[all, idle, avg15] pour obtenir des données spécifiques sur l’utilisation du processeur.

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

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

Il est désormais possible de configurer plusieurs règles de découverte 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 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 quelconques.
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

L’intervalle de temps en secondes qui détermine la fréquence à laquelle les valeurs sont envoyées depuis le tampon vers le serveur Zabbix. Notez que si le tampon est plein, les données seront envoyées plus tôt.

Par défaut : 5
Plage : 1-3600

BufferSize

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

Le socket de contrôle, utilisé pour envoyer des commandes d’exécution avec l’option « -R ».

Par défaut : /tmp/agent.sock

DebugLevel

Spécifiez 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 sur les erreurs ;
3 - avertissements ;
4 - pour le débogage (produit beaucoup d’informations) ;
5 - débogage étendu (produit encore plus d’informations).

Par défaut : 3
Plage : 0-5

DenyKey

Refuse 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 quelconques.
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 : Restriction des vérifications de l’agent.

EnablePersistentBuffer

Active 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

La fréquence des messages de pulsation en secondes. Utilisée pour surveiller la disponibilité des contrôles actifs.
0 - messages de pulsation désactivés.

Par défaut : 60
Plage : 0-3600

HostInterface

Paramètre facultatif qui définit l’interface de l’hôte (adresse IP ou nom DNS) utilisée pendant le processus d’autoregistration de l’hôte. Cette valeur sera utilisée pour renseigner l’interface dans l’hôte nouvellement créé et permet de configurer explicitement soit une adresse IP, soit une adresse DNS. Pour plus de détails, voir Utilisation de DNS comme interface par défaut.

S’il n’est pas défini, 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

Un paramètre facultatif qui définit un élément utilisé pour déterminer l’interface de l’hôte (adresse IP ou nom DNS) pendant le processus d’autoregistration de l’hôte. Cette valeur est utilisée uniquement si HostInterface n’est pas défini. Pour plus de détails, voir Utilisation de DNS comme interface par défaut.

Lors d’une requête 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 255 caractères.

L’élément system.run[] est pris en charge независимо des paramètres AllowKey/DenyKey.

HostMetadata

Un paramètre facultatif qui définit les métadonnées utilisées pour identifier ou distinguer l’hôte pendant le processus d’enregistrement automatique de l’hôte. HostMetadata permet de distinguer les hôtes au-delà du nom d’hôte.

S’il n’est pas défini, 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 n’est pas une chaîne UTF-8 valide. Lorsqu’un paramètre attend une adresse IP ou un nom DNS, les valeurs qui sont valides en UTF-8 mais ne sont pas des adresses IP ou des noms DNS valides seront également rejetées et signalées comme invalides.

Plage : 0-2034 octets

HostMetadataItem

Un paramètre facultatif qui définit un élément d’agent Zabbix utilisé pour obtenir les métadonnées de l’hôte. Cette option n’est utilisée que lorsque HostMetadata n’est pas défini.

La valeur de HostMetadataItem est récupérée à chaque tentative d’auto-enregistrement et n’est utilisée que lors du processus d’auto-enregistrement 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 независимо des paramètres AllowKey/DenyKey.

Lors d’une requête 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 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 qui sont valides en UTF-8 mais ne sont pas des adresses IP ou des noms DNS valides seront également rejetées et signalées comme invalides.

Hostname

Une liste de noms d’hôte uniques, sensibles à la casse, séparés par des virgules. Obligatoire 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

Un paramètre facultatif qui définit un élément utilisé pour obtenir le nom d’hôte. Cette option n’est utilisée que 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 quelles que soient les valeurs de AllowKey/DenyKey.

Par défaut : system.hostname

Include

Vous pouvez inclure des fichiers individuels ou tous les fichiers d’un répertoire dans le fichier de configuration. Lors de l’installation, Zabbix créera le répertoire d’inclusion dans /usr/local/etc, sauf s’il a été modifié au moment 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.
Voir les notes spéciales concernant les limitations.

Exemple :

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

ListenIP

Une liste d’adresses IP séparées par des virgules sur lesquelles l’agent doit écouter. La première adresse IP est envoyée au serveur Zabbix, lors de la connexion à celui-ci, afin de récupérer la liste des contrôles actifs.

Par défaut : 0.0.0.0

ListenPort

L'agent écoutera sur ce port les connexions provenant du serveur.

Par défaut : 10050
Plage : 1024-32767

LogFile

Le nom du fichier journal.

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

LogFileSize

La taille maximale d’un fichier journal en Mo.
0 - désactiver la rotation automatique des journaux.
Remarque : si la limite de taille du fichier journal est atteinte et que la rotation du fichier échoue, pour quelque raison que ce soit, le fichier journal existant est tronqué et recommencé à zéro.

Par défaut : 1
Plage : 0-1024

LogType

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

Par défaut : file

PersistentBufferFile

Le fichier dans lequel l’agent Zabbix 2 doit conserver la base de données SQLite. Doit être un nom de fichier complet. Ce paramètre n’est utilisé que si le tampon persistant est activé (EnablePersistentBuffer=1).

PersistentBufferPeriod

La période pendant laquelle les données doivent être stockées lorsqu’il n’y a pas de connexion au serveur ou au proxy. Les données plus anciennes seront perdues. Les données de journal seront conservées. Ce paramètre n’est utilisé que si le tampon persistant est activé (EnablePersistentBuffer=1).

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

PidFile

Le nom du fichier PID.

Par défaut : /tmp/zabbix_agent2.pid

Plugins.<PluginName>.System.Capacity

La limite de contrôles par plugin <PluginName> pouvant être exécutés en même temps.

Par défaut : 1000 Plage : 1-1000

Plugins.Log.MaxLinesPerSecond

Le nombre maximal de nouvelles lignes que l'agent enverra par seconde au serveur ou au proxy Zabbix lors du traitement des contrôles actifs 'log' et '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

Activez la journalisation des commandes shell exécutées en tant qu’avertissements. Les commandes ne seront journalisé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

Le chemin vers le socket UNIX pour les communications avec les plugins chargeables.

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

PluginTimeout

Le délai d’expiration des connexions avec les plugins chargeables, en secondes.

Par défaut : Timeout
Plage : 1-30

RefreshActiveChecks

Fréquence de rafraîchissement de la liste des contrôles actifs, en secondes. Notez qu'après un échec du rafraîchissement des contrôles actifs, la prochaine tentative de rafraîchissement sera effectuée dans 60 secondes.

Par défaut : 5
Plage : 1-86400

Server

Une liste d’adresses IP séparées par des virgules, éventuellement en notation CIDR, ou de noms DNS de serveurs Zabbix ou de proxies Zabbix. Les connexions entrantes seront acceptées uniquement 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ées de manière identique et '::/0' autorisera toute adresse IPv4 ou IPv6. '0.0.0.0/0' peut être utilisé pour autoriser toute 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

L'adresse du serveur/proxy Zabbix ou la configuration du cluster pour obtenir les contrôles actifs. L'adresse du serveur/proxy est une adresse IP ou un nom DNS, avec un port optionnel 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 proxys, séparées par des points-virgules. Plusieurs serveurs/clusters Zabbix et proxys Zabbix peuvent être spécifiés, séparés par des virgules. Sauf en cas d'utilisation de groupes de proxys, il ne faut pas spécifier plus d'un proxy Zabbix pour chaque serveur/cluster Zabbix. Si un proxy Zabbix est spécifié, 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 en parallèle plusieurs serveurs Zabbix indépendants. 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 un port est spécifié pour cet hôte. 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 contrôles actifs sont désactivés.

Exemple pour un proxy Zabbix :

ServerActive=127.0.0.1:10051

Exemple pour un groupe de proxys 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 de haute disponibilité :

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

Exemple de 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

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

Si ce paramètre est défini, l'agent écoutera sur ce port les requêtes de statut HTTP (http://localhost:<port>/status).

Plage : 1024-32767

Délai d'attente

Spécifie combien de temps attendre (en secondes) pour établir une 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 d’élément dans les contrôles actifs ;
• la récupération des données de journal via logfile ;
• l’envoi de messages heartbeat ;
• la durée maximale des contrôles vfs.* ;
• l’utilisation comme solution de repli dans les cas où un serveur ou un proxy antérieur à la version 7.0 envoie des contrôles sans délais d’attente.

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

Par défaut : 3
Plage : 1-30

TLSAccept

Les connexions entrantes à accepter. Utilisé pour les contrôles passifs. Plusieurs valeurs peuvent être spécifiées, séparées par des virgules :
unencrypted - accepter les connexions sans chiffrement (par défaut)
psk - accepter les connexions avec TLS et une clé pré-partagée (PSK)
cert - accepter les connexions avec TLS et un certificat

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

TLSCAFile

Le chemin complet du fichier contenant les certificats de la ou des autorités 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

Le chemin 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

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

Exemple :

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

TLSCipherAll13

La chaîne de chiffrement OpenSSL (TLS 1.3) pour OpenSSL 1.1.1 ou version ultérieure. Remplace les critères de sélection par défaut des suites cryptographiques pour le chiffrement basé sur des certificats et sur PSK.

Exemple :

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSCipherCert

La chaîne de chiffrement OpenSSL (TLS 1.2). Remplace les critères de sélection par défaut de la suite de chiffrement pour le chiffrement basé sur un certificat.

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

La chaîne de chiffrement OpenSSL (TLS 1.3) pour OpenSSL 1.1.1 ou version ultérieure. Remplace les critères de sélection par défaut de la suite cryptographique pour le chiffrement basé sur un certificat.

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

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

Exemple :

kECDHEPSK+AES128:kPSK+AES128

TLSCipherPSK13

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

Exemple :

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

TLSConnect

Comment l'agent doit se connecter au serveur ou au proxy Zabbix. Utilisé pour les contrôles actifs. Une seule valeur peut être spécifiée :
unencrypted - se connecter sans chiffrement (par défaut)
psk - se connecter à l’aide de TLS et d’une clé pré-partagée (PSK)
cert - se connecter à l’aide de TLS et d’un certificat

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

TLSCRLFile

Le chemin complet du fichier contenant les certificats révoqués. Ce paramètre est utilisé pour les communications chiffrées entre les composants Zabbix.

TLSKeyFile

Le chemin complet du fichier contenant la clé privée de l’agent, utilisée pour les communications chiffrées entre les composants Zabbix.

TLSPSKFile

Le chemin complet du fichier contenant la clé pré-partagée de l’agent, utilisée pour les communications chiffrées avec le serveur Zabbix.

TLSPSKIdentity

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

TLSServerCertIssuer

L’émetteur autorisé du certificat du serveur (proxy).

TLSServerCertSubject

Le sujet du certificat autorisé du serveur (proxy).

UnsafeUserParameters

Autoriser le passage de tous les caractères 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

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 une fin de ligne.
Les commandes shell peuvent avoir 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

Le chemin de recherche par défaut pour les commandes UserParameter. S’il est utilisé, l’agent changera son répertoire de travail pour celui spécifié ici avant d’exécuter une commande. Ainsi, les commandes UserParameter peuvent avoir un préfixe relatif ./ au lieu d’un chemin complet.
Une seule entrée est autorisée.

Exemple :

UserParameterDir=/opt/myscripts