Superviser les valeurs d'une API JSON
Interrogez l'API d'un hôte (par exemple, les consommables d'une imprimante), consultez son JSON et choisissez en un clic les valeurs supervisées, chacune avec sa métrique et ses seuils.
De nombreux hôtes disposent d'une API qui répond en JSON : imprimantes (niveaux d'encre ou de toner), onduleurs, contrôleurs, systèmes propres. Un test API JSON interroge cette API, prend les valeurs que vous choisissez et en fait des métriques de l'appareil : avec leur graphique et leur état dans la fiche de l'hôte dans Infrastructure, comme toute autre supervision.
Avant de commencer
Il vous faut Administrer sur Plugins pour créer le test et Opérer pour l'associer à un hôte.
La requête est faite par la sonde de supervision (3.3.0 ou supérieure) qui supervise l'hôte. Le test ne s'associe qu'aux hôtes supervisés par une sonde ; l'agent d'un serveur et le cloud ARGUNIS ne l'exécutent pas.
Si l'API demande un jeton ou un utilisateur et un mot de passe, créez-les d'abord dans le coffre-fort (Paramètres → Supervision → Identifiants). Ils ne s'écrivent jamais dans le test.
Étapes
Allez dans Paramètres → Supervision → Tests de supervision et appuyez sur Nouveau test.
Saisissez le Nom (par exemple, « Imprimante HP · encres »).
Dans Plugin, choisissez API JSON : interroger un JSON et choisir ses valeurs (toujours exécuté par une sonde).
Dans URL de l'API, saisissez l'adresse avec les macros de l'appareil, par exemple
https://$HOSTADDRESS$/cdm/supply/v1/suppliesPublic. Ainsi, le même test sert pour toutes les imprimantes de ce modèle.Si l'hôte utilise un certificat propre (c'est le cas habituel des imprimantes), cochez Accepter le certificat propre de l'hôte.
Dans Interroger, recherchez un Appareil d'exemple supervisé par une sonde (et choisissez l'Identifiant si l'API le demande) et appuyez sur Interroger : la requête est faite par la sonde de cet appareil.
Vous verrez le JSON de l'API. À côté de chaque valeur numérique, appuyez sur Superviser : elle s'ajoute au tableau des Valeurs supervisées avec un nom, sa métrique et son chemin.
Dans le tableau, ajustez le Nom, l'Unité, si l'alerte se déclenche quand la valeur descend sous ou dépasse, et les seuils d'Avertissement et de Critique. Par exemple, pour une encre : « descend sous », avertissement 20 et critique 10.
Appuyez sur Enregistrer.
Associez-le ensuite aux hôtes depuis leur fiche (Ajouter depuis le catalogue) ou avec une Créer une étiquette de supervision.
Dans une liste (par exemple, la liste des consommables), ARGUNIS recherche l'élément selon son contenu et non selon sa position : le chemin devient suppliesList[supplyType=inkTank, supplyColorCode=K].percentLifeDisplay (le réservoir d'encre noire). Si l'hôte change l'ordre de la liste, la valeur est toujours trouvée.
Ce qui se passe ensuite
Chaque valeur est une métrique de la supervision dans la fiche de l'hôte, avec son graphique.
L'état de la supervision est le pire de ses valeurs. Si l'API ne répond pas, ne renvoie pas de JSON ou si une valeur manque, elle passe en critique et le texte en indique la raison.
Jusqu'à 20 valeurs par test, une réponse de 1 Mo au maximum et un intervalle d'au moins 30 secondes.
Les requêtes POST, PUT, PATCH et DELETE peuvent modifier des données sur l'hôte : elles doivent être confirmées à l'enregistrement.