3 Découverte de bas niveau

Aperçu

La découverte de bas niveau permet de créer automatiquement des éléments, des déclencheurs et des graphiques pour différentes entités sur un ordinateur. Par exemple, Zabbix peut démarrer automatiquement la surveillance des systèmes de fichiers ou des interfaces réseaux sur votre ordinateur, sans qu'il soit nécessaire de créer manuellement des éléments pour chaque système de fichiers ou interface réseau. De plus, il est possible de configurer Zabbix pour qu'il supprime automatiquement les entités inutiles en fonction des résultats réels de la découverte effectuée périodiquement.

Un utilisateur peut définir ses propres types de découverte, à condition de suivre un protocole JSON particulier.

L'architecture générale du processus de découverte est la suivante.

Tout d'abord, un utilisateur crée une règle de découverte dans la colonne "Configuration" → "Modèles" → "Découverte". Une règle de découverte consiste en (1) un élément qui découvre les entités nécessaires (par exemple, des systèmes de fichiers ou des interfaces réseau) et (2) des prototypes d'éléments, de déclencheurs et de graphiques qui doivent être créés en fonction de la valeur de cet élément.

Un élément qui découvre les entités nécessaires est comme un élément standard vu ailleurs : le serveur demande à un agent Zabbix (ou quel que soit le type d'élément défini) une valeur de cet élément, l'agent répond avec une valeur textuelle. La différence est que la valeur avec laquelle l'agent répond doit contenir une liste d'entités découvertes dans un format JSON spécifique. Bien que les détails de ce format ne soient importants que pour les développeurs de vérifications de découverte personnalisées, il est nécessaire de savoir que la valeur renvoyée contient une liste de paires macro → valeur. Par exemple, l'élément "net.if.discovery" peut renvoyer deux paires : "{#IFNAME}" → "lo" et "{#IFNAME}" → "eth0".

Ces macros sont utilisées dans les noms, les clés et les autres champs prototypes où elles sont ensuite remplacées par les valeurs reçues pour créer des éléments réels, des déclencheurs, des graphiques ou même des hôtes pour chaque entité découverte. Consultez la liste complète des options d'utilisation des macros LLD.

Lorsque le serveur reçoit une valeur pour un élément de découverte, il examine les paires macro → valeur et génère pour chaque paire des éléments réels, des déclencheurs et des graphiques, en fonction de leurs prototypes. Dans l'exemple avec "net.if.discovery" ci-dessus, le serveur générerait un ensemble d'éléments, de déclencheurs et de graphiques pour l'interface loopback "lo" et un autre ensemble pour l'interface "eth0".

Notez que depuis ** Zabbix 4.2 **, le format du JSON renvoyé par les règles de découverte de bas niveau a été modifié. Il n'est plus prévu que le JSON contienne l'objet "data". La découverte de bas niveau acceptera désormais un JSON normal contenant un tableau, afin de prendre en charge de nouvelles fonctionnalités telles que le prétraitement de la valeur d'élément et les chemins personnalisés vers les valeurs de macro de découverte de bas niveau dans un document JSON.

Les clés de découverte intégrées ont été mises à jour pour renvoyer un tableau de lignes LLD à la racine du document JSON. Zabbix extraira automatiquement une macro et une valeur si un champ de tableau utilise la syntaxe {#MACRO} comme clé. Toute nouvelle vérification de découverte native utilisera la nouvelle syntaxe sans les éléments "data". Lors du traitement d'une valeur de découverte de bas niveau, la racine est d'abord localisée (tableau à $. ou $.data).

Bien que l'élément "data" ait été supprimé de tous les éléments natifs liés à la découverte, pour des raisons de rétrocompatibilité, Zabbix acceptera toujours la notation JSON avec un élément "data", bien que son utilisation soit déconseillée. Si le JSON contient un objet avec un seul élément de tableau "data", il extraira automatiquement le contenu de l'élément en utilisant JSONPath $.data. La découverte de bas niveau accepte désormais les macros LLD facultatives définies par l'utilisateur avec un chemin personnalisé spécifié dans la syntaxe JSONPath.

Voir aussi : Entités découvertes

Configuration de la découverte de bas niveau

Nous allons illustrer la découverte de bas niveau en nous basant sur un exemple de découverte de système de fichiers.

Pour configurer la découverte, procédez comme suit :

• Aller dans : Configuration → Modèles ou Hôtes
• Cliquez sur Découverte dans la ligne d'un modèle/hôte approprié.

• Cliquez sur Créer une règle de découverte dans le coin supérieur droit de l'écran.
• Remplissez le formulaire de règle de découverte avec les détails requis

Règle de découverte

Le formulaire de règle de découverte contient cinq onglets, représentant, de gauche à droite, le flux de données lors de la découverte :

• Règle de découverte - spécifie, surtout, l'élément intégré ou le script personnalisé pour récupérer les données de découverte
• Prétraitement - applique un prétraitement aux données découvertes
• Macros LLD - permet d'extraire certaines valeurs de macro à utiliser dans les éléments découverts, les déclencheurs, etc.
• Filtres - permet de filtrer les valeurs découvertes
• Surcharge - permet de modifier des éléments, des déclencheurs, des graphiques ou des prototypes d'hôte lors de l'application à des objets découverts spécifiques

L'onglet Règle de découverte contient la clé d'élément à utiliser pour la découverte (ainsi que certains attributs généraux de la règle de découverte) :

Tous les champs de saisie obligatoires sont marqués d'un astérisque rouge.

Prétraitement

L'onglet Prétraitement permet de définir des règles de transformation à appliquer au résultat de la découverte. Une ou plusieurs transformations sont possibles dans cette étape. Les transformations sont exécutées dans l'ordre dans lequel elles sont définies. Tout le prétraitement est effectué par le serveur Zabbix.

Voir également :

• Détails du prétraitement
• Tests de prétraitement

Notez que si la règle de découverte a été appliquée à l'hôte via un modèle, le contenu de cet onglet est en lecture seule.

Macros personnalisées

L'onglet Macros LLD permet de spécifier des macros de découverte personnalisées de bas niveau.

Les macros personnalisées sont utiles dans les cas où le JSON renvoyé n'a pas les macros requises déjà définies. Ainsi, par exemple :

• La clé native vfs.fs.discovery pour la découverte du système de fichiers renvoie un JSON avec des macros LLD prédéfinies telles que {#FSNAME}, {#FSTYPE}. Ces macros peuvent être utilisées dans l'élément, déclencher des prototypes (voir les sections suivantes de la page) directement ; la définition de macros personnalisées n'est pas nécessaire ;
• L'élément d'agent vfs.fs.get renvoie également un JSON avec les données du système de fichiers, mais sans macros LLD prédéfinies. Dans ce cas, vous pouvez définir vous-même les macros et les mapper aux valeurs du JSON à l'aide de JSONPath :

Les valeurs extraites peuvent être utilisées dans les éléments découverts, les déclencheurs, etc. Notez que les valeurs seront extraites du résultat de la découverte et de toutes les étapes de pré-traitement traitées jusqu'à présent.

Filtre

Un filtre peut être utilisé pour générer des éléments réels, des déclencheurs et des graphiques uniquement pour les entités qui correspondent aux critères. L'onglet Filtres contient des définitions de filtre de règle de découverte permettant de filtrer les valeurs de découverte :

Surcharge

L'onglet Surcharges permet de définir des règles pour modifier la liste des prototypes d'éléments, de déclencheurs, de graphiques et d'hôtes ou leurs attributs pour les objets découverts qui répondent à des critères donnés.

Les surcharges (le cas échéant) sont affichées dans une liste réorganisable par glisser-déposer et exécutés dans l'ordre dans lequel ils sont définis. Pour configurer les détails d'une nouvelle surcharge, cliquez sur dans le bloc Surcharges. Pour modifier une surcharge existante, cliquez sur le nom de la surcharge. Une fenêtre contextuelle s'ouvrira permettant de modifier les détails de la règle de surcharge.

Tous les paramètres obligatoires sont signalés par des astérisques rouges.

Configurer une opération

Pour configurer les détails d'une nouvelle opération, cliquez sur dans le bloc Opérations. Pour modifier une opération existante, cliquez sur à côté de l'opération. Une fenêtre contextuelle dans laquelle vous pouvez modifier les détails de l'opération s'ouvrira.

Paramètre			Description
Objet			Quatre types d'objets sont disponibles : Prototype d'élément Prototype de déclencheur Prototype de graphique Prototype d'hôte
Condition			Permet de filtrer les entités auxquelles l'opération doit être appliquée.
	Opérateur		Opérateurs pris en charge : égal - s'applique à ce prototype n'est pas égal - s'applique à tous les prototypes, sauf celui-ci contient - s'applique, si le nom du prototype contient une chaîne ne contient pas - s'applique, si le nom du prototype ne contient pas une chaîne correspond - s'applique, si le nom du prototype correspond à l'expression régulière ne correspond pas - s'applique, si le nom du prototype ne correspond pas à l'expression régulière
	Motif		Une expression régulière ou une chaîne à rechercher.
	Objet: Prototype d'élément
		Créer activé	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres de prototype d'élément d'origine : Oui - l'élément sera ajouté dans un état activé. Non - le élément sera ajouté à une entité découverte mais dans un état désactivé.
		Découvrir	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres du prototype d'élément d'origine : Oui - l'élément sera ajouté. Non - l'élément ne sera pas ajouté.
		Intervalle d'actualisation	Lorsque la case est cochée, deux options apparaîtront, permettant de définir un intervalle différent pour l'élément : Délai - Intervalle de mise à jour de l'élément. Les macros utilisateur et les suffixes temporels (par exemple, 30s, 1m, 2h, 1d) sont pris en charge. Doit être défini sur 0 si Intervalle personnalisé est utilisé. Intervalle personnalisé - cliquez sur pour spécifier un intervalle flexible/planifié. Pour des informations détaillées, voir Intervalles personnalisés.
		Période de stockage de l'historique	Lorsque la case est cochée, les boutons apparaissent, permettant de définir une période de stockage de l'historique différente pour l'élément : Ne pas conserver l'historique - si sélectionné, l'historique ne sera pas être stocké. Période de stockage - si sélectionné, un champ de saisie pour spécifier la période de stockage apparaîtra à droite. Les macros utilisateur et les macros LLD sont prises en charge.
		Période de stockage des tendances	Lorsque la case est cochée, les boutons apparaissent, permettant de définir une période de stockage des tendances différente pour l'élément : Ne pas conserver les tendances - si sélectionné, les tendances ne seront pas être stocké. Période de stockage - si sélectionné, un champ de saisie pour spécifier la période de stockage apparaîtra à droite. Les macros utilisateur et les macros LLD sont prises en charge.
		Tags	Lorsque la case est cochée, un nouveau bloc apparaîtra, permettant de spécifier des paires tag-valeur. Ces tags seront ajoutés aux tags spécifiés dans le prototype de l'élément, même si les noms de tag correspondent.
	Objet : Prototype de déclencheur
		Créer activé	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres originaux du prototype de déclencheur : Oui - le déclencheur sera ajouté dans un état activé. Non - le déclencheur sera ajouté à une entité découverte, mais dans un état désactivé.
		Découvrir	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres originaux du prototype de déclencheur : Oui - le déclencheur sera ajouté. Non - le déclencheur ne sera pas ajouté.
		Sévérité	Lorsque la case est cochée, des boutons de sévérité du déclencheur apparaîtront, permettant de modifier la sévérité du déclencheur.
		Tags	Lorsque la case est cochée, un nouveau bloc apparaîtra, permettant de spécifier des paires tag-valeur. Ces tags seront ajoutés aux tags spécifiés dans le prototype du déclencheur, même si les noms de tag correspondent.
	Objet : Prototype de graphique
		Découvrir	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres originaux du prototype de graphique : Oui - le graphique sera ajouté. Non - le graphique ne sera pas ajouté .
	Objet : Prototype d'hôte
		Créer activé	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres du prototype d'hôte d'origine : Oui - l'hôte sera créé dans un état activé. Non - le l'hôte sera créé dans un état désactivé.
		Découvrir	Lorsque la case est cochée, les boutons apparaîtront, permettant de remplacer les paramètres du prototype d'hôte d'origine : Oui - l'hôte sera découvert. Non - l'hôte ne sera pas découvert.
		Lier les modèles	Lorsque la case est cochée, un champ de saisie pour spécifier les modèles apparaîtra. Commencez à saisir le nom du modèle ou cliquez sur Sélectionner à côté du champ et sélectionnez des modèles dans la liste dans une fenêtre contextuelle. Tous les modèles liés à un prototype hôte seront remplacés par les modèles de cette surcharge.
		Tags	Lorsque la case est cochée, un nouveau bloc apparaîtra, permettant de spécifier des paires tag-valeur. Ces tags seront ajoutés aux tags spécifiés dans le prototype de l'hôte, même si les noms de tag correspondent.
		Inventaire de l'hôte	Lorsque la case est cochée, les boutons apparaîtront, permettant de sélectionner un mode d'inventaire différent pour le prototype d'hôte : Désactivé - ne pas remplir l'inventaire de l'hôte Manuel - fournir les détails manuellement Automatique - remplir automatiquement les données d'inventaire de l'hôte en fonction des métriques collectées.

Boutons de formulaire

Des boutons en bas du formulaire permettent d'effectuer plusieurs opérations.

	Ajouter une règle de découverte. Ce bouton n'est disponible que pour les nouvelles règles de découverte.
	Mettre à jour les propriétés d'une règle de découverte. Ce bouton n'est disponible que pour les règles de découverte existantes.
	Créer une autre règle de découverte basée sur les propriétés de la règle de découverte actuelle.
	Effectuer immédiatement une découverte basée sur la règle de découverte. La règle de découverte doit déjà exister. Voir plus de détails. Notez que lors d'une découverte immédiate, le cache de configuration n'est pas mis à jour, donc le résultat ne reflétera pas les modifications très récentes apportées à la configuration de la règle de découverte.
	Supprimer la règle de découverte.
	Annuler la modification des propriétés de la règle de découverte.

Entités découvertes

Les captures d'écran ci-dessous illustrent à quoi ressemblent les éléments, les déclencheurs et les graphiques découverts dans la configuration de l'hôte. Les entités découvertes sont précédées d'un lien orange vers une règle de découverte dont elles proviennent.

Notez que les entités découvertes ne seront pas créées s'il existe déjà des entités existantes avec les mêmes critères d'unicité, par exemple, un élément avec la même clé ou un graphique avec le même nom. Un message d'erreur s'affiche dans ce cas dans le frontend indiquant que la règle de découverte de bas niveau n'a pas pu créer certaines entités. La règle de découverte elle-même, cependant, ne deviendra pas non prise en charge car certaines entités n'ont pas pu être créées et ont dû être ignorées. La règle de découverte continuera à créer/mettre à jour d'autres entités.

Les éléments (de même que les déclencheurs et les graphiques) créés par une règle de découverte de bas niveau seront automatiquement supprimés si une entité découverte (système de fichiers, interface, etc.) cesse d'être découverte (ou ne passe plus le filtre). Dans ce cas, les éléments, les déclencheurs et les graphiques seront supprimés après les jours définis dans le champ Période de conservation des ressources perdues passés.

Lorsque les entités découvertes deviennent 'Plus découvertes', un indicateur de durée de vie s'affiche dans la liste des éléments. Déplacez le pointeur de votre souris dessus et un message s'affichera indiquant combien de jours il reste jusqu'à ce que l'élément soit supprimé.

Si des entités ont été marquées pour suppression, mais n'ont pas été supprimées au moment prévu (règle de découverte ou hôte d'élément désactivé), elles seront supprimées lors du prochain traitement de la règle de découverte.

Les entités contenant d'autres entités, qui sont marquées pour suppression, ne seront pas mises à jour si elles sont modifiées au niveau de la règle de découverte. Par exemple, les déclencheurs basés sur LLD ne seront pas mis à jour s'ils contiennent des éléments marqués pour suppression.

Autres types de découverte

Plus de détails et de procédures sur d'autres types de découvertes prêtes à l'emploi sont disponibles dans les sections suivantes :

• découverte des interfaces réseau;
• découverte des CPU et cœurs de CPU ;
• découverte des OID SNMP ;
• découverte des objets JMX;
• découverte à l'aide de requêtes SQL ODBC ;
• découverte des services Windows ;
• découverte des interfaces hôtes dans Zabbix.

Pour plus de détails sur le format JSON des éléments de découverte et un exemple d'implémentation de votre propre outil de découverte de système de fichiers avec un script Perl, consultez la création de règles LLD personnalisées.

Création de règles LLD personnalisées

Il est également possible de créer une règle LLD entièrement personnalisée, découvrant tout type d'entités - par exemple, des bases de données sur un serveur de base de données.

Pour ce faire, un élément personnalisé doit être créé qui renvoie JSON, en spécifiant les objets trouvés et éventuellement - certaines de leurs propriétés. Le nombre de macros par entité n'est pas limité - alors que les règles de découverte intégrées renvoient une ou deux macros (par exemple, deux pour la découverte du système de fichiers), il est possible d'en renvoyer davantage.

Le format JSON requis est mieux illustré par un exemple. Supposons que nous exécutons un ancien agent Zabbix 1.8 (qui ne prend pas en charge "vfs.fs.discovery"), mais que nous devons encore découvrir les systèmes de fichiers. Voici un script Perl simple pour Linux qui découvre les systèmes de fichiers montés et génère JSON, qui inclut à la fois le nom et le type du système de fichiers. Une façon de l'utiliser serait en tant que UserParameter avec la clé "vfs.fs.discovery_perl":

#!/usr/bin/perl
       
       $first = 1;
       
       print "[\n";
       
       for (`cat /proc/mounts`)
       {
           ($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
       
           print "\t,\n" if not $first;
           $first = 0;
       
           print "\t{\n";
           print "\t\t\"{#FSNAME}\":\"$fsname\",\n";
           print "\t\t\"{#FSTYPE}\":\"$fstype\"\n";
           print "\t}\n";
       }
       
       print "]\n";

Un exemple de sa sortie (reformaté pour plus de clarté) est présenté ci-dessous. Le JSON pour les vérifications de découverte personnalisées doit suivre le même format.

[
           { "{#FSNAME}":"/",                           "{#FSTYPE}":"rootfs"   },
           { "{#FSNAME}":"/sys",                        "{#FSTYPE}":"sysfs"    },
           { "{#FSNAME}":"/proc",                       "{#FSTYPE}":"proc"     },
           { "{#FSNAME}":"/dev",                        "{#FSTYPE}":"devtmpfs" },
           { "{#FSNAME}":"/dev/pts",                    "{#FSTYPE}":"devpts"   },
           { "{#FSNAME}":"/lib/init/rw",                "{#FSTYPE}":"tmpfs"    },
           { "{#FSNAME}":"/dev/shm",                    "{#FSTYPE}":"tmpfs"    },
           { "{#FSNAME}":"/home",                       "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/tmp",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/usr",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/var",                        "{#FSTYPE}":"ext3"     },
           { "{#FSNAME}":"/sys/fs/fuse/connections",    "{#FSTYPE}":"fusectl"  }
       ]

Dans l'exemple précédent, il est nécessaire que les clés correspondent aux noms de macro LLD utilisés dans les prototypes, l'alternative consiste à extraire les valeurs de macro LLD à l'aide de JSONPath {#FSNAME} → $.fsname et {#FSTYPE} → $.fstype, rendant ainsi possible un tel script:

#!/usr/bin/perl
        
       $first = 1;
        
       print "[\n";
        
       for (`cat /proc/mounts`)
       {
           ($fsname, $fstype) = m/\S+ (\S+) (\S+)/;
        
           print "\t,\n" if not $first;
           $first = 0;
        
           print "\t{\n";
           print "\t\t\"fsname\":\"$fsname\",\n";
           print "\t\t\"fstype\":\"$fstype\"\n";
           print "\t}\n";
       }
        
       print "]\n";

Un exemple de sa sortie (reformaté pour plus de clarté) est présenté ci-dessous. Le JSON pour les vérifications de découverte personnalisées doit suivre le même format.

[
           { "fsname":"/",                           "fstype":"rootfs"   },
           { "fsname":"/sys",                        "fstype":"sysfs"    },
           { "fsname":"/proc",                       "fstype":"proc"     },
           { "fsname":"/dev",                        "fstype":"devtmpfs" },
           { "fsname":"/dev/pts",                    "fstype":"devpts"   },
           { "fsname":"/lib/init/rw",                "fstype":"tmpfs"    },
           { "fsname":"/dev/shm",                    "fstype":"tmpfs"    },
           { "fsname":"/home",                       "fstype":"ext3"     },
           { "fsname":"/tmp",                        "fstype":"ext3"     },
           { "fsname":"/usr",                        "fstype":"ext3"     },
           { "fsname":"/var",                        "fstype":"ext3"     },
           { "fsname":"/sys/fs/fuse/connections",    "fstype":"fusectl"  }
       ]

Ensuite, dans le champ "Filtre" de la règle de découverte, nous pourrions spécifier "{#FSTYPE}" comme macro et "rootfs|ext3" comme expression régulière.

Notez que, si vous utilisez un paramètre utilisateur, la valeur de retour est limitée à 512 Ko. Pour plus de détails, voir les limites de données pour les valeurs de retour LLD.