EV Observe - Utiliser le modèle de service Global-Plugin-Execution

Modifié le 25/11/2022 17:19

Attention :

  • EasyVista assure uniquement le support sur l’exécution du code fourni par le client. Aucun support n'est assuré sur le code.
  • EasyVista se réserve le droit de déplacer/modifier le code fourni par le client et d’arrêter son fonctionnement en cas d’activité anormale au niveau de la plateforme et en cas de doute raisonnable du technicien. Dans ce cas, le client est informé selon les procédures usuelles.
  • EasyVista n’assure plus de support sur une Box dont des éléments ont pu être modifiés (en plus du fichier déposé par le client), notamment en cas d’installation ou de mise à jour de logiciels complémentaires (paquets) ou du système d’exploitation de la Box.

Le modèle de service Global-Plugin-Execution permet d’exécuter un programme personnalisé par le client qui est déposé sur les Box.

Le programme doit respecter certaines conditions pour pouvoir être mis en place sur les Box  - Open url.png voir Configuration du programme

Remarques

  • Le programme personnalisé doit être déployé sur l'ensemble des Box du parc informatique.
  • Les informations retournées par le programme personnalisé sont stockées de façon chiffrées en base de données. Elles restent visibles à toute personne ayant accès à la page de configuration du service unitaire.

Configuration du programme personnalisé

  • Encodage du fichier : LATIN
  • Le programme doit avoir un code retour selon le tableau ci-dessous.
Valeur Statut interprété dans EV Observe
0 OK ==> Status icon - OK.png
1 Alerte ==> Status icon - Warning.png
2 Critique ==> Status icon - Critical.png
3 Inconnu ==> Status icon - Unknown.png
  • Le retour doit être fourni sur une seule ligne.
  • Le retour peut contenir des données de performance. Dans ce cas, il doit être de la forme suivante.

    texte affiché dans le champ détail EV Observe| ‘nommetrique’=valeur[unité];[seuil alerte];[seuil critique];[valeur min];[valeur max]

    • Liste de noms de métriques / Valeur séparées par des espaces
    • Le nom de la métrique peut contenir n’importe quel caractère sauf le signe égal ou le signe quote (‘).
    • Les guillemets simples pour le nom de la métrique sont facultatifs. Ils sont obligatoire si nommétrique contient des espaces.
    • Le nom de la métrique est libre. Il doit être inférieur à 19 caractères et unique dans la ligne de retour et ne pas contenir le signe quote (‘).
    • [seuil alerte];[seuil critique];[valeur min];[valeur max] peuvent être nuls (par exemple, si le seuil n’est pas défini ou si min et max ne s’appliquent pas). Les points-virgules non remplis peuvent être supprimés. Min et max ne sont pas requis si l’unité est %
    • valeur, seuil alerte, seuil critique, min et max sont dans la classe [-0-9] et doivent tous être de la même unité pour une métrique donnée.
    • Unité est une chaîne d’un ou plusieurs caractères. Les caractères suivants sont exclus : nombres, points-virgules, guillemets simples ou doubles.

      exemple  

      • aucune unité spécifiée : Indique un certain nombre (int ou float) d’entités, tels utilisateurs, processus, moyennes de charge
      • s – secondes (aussi min, ms, …)
      • % – pourcentage
      • B – octets (également KB, MB, TB)

Procédure : Comment utiliser le modèle de service

Note : Assurez-vous que le programme personnalisé respecte les conditions pour pouvoir être mis en place sur les Box.
Open url.png voir Configuration du programme

Étape 1 : Déploiement du programme personnalisé sur l'ensemble des Box

1. Copiez le programme dans le dossier de la Box, en exécutant la commande ci-dessous.

usr/local/nagios/libexec/custom_plugin

2. Attribuez les droits d’exécution et d’appartenance, en exécutant les commandes ci-dessous.

Remplacez <PluginName.pl> par le nom de votre programme. Attention : L'extension doit être .pl.

chown nagios:nagios usr/local/nagios/libexec/custom_plugin/<PluginName.pl>

chmod 755 /usr/local/nagios/libexec/custom_plugin/<PluginName.pl>

3. Réalisez ces actions sur l'ensemble des Box de votre parc informatique.
 

Étape 2 : Mise en supervision du programme personnalisé via le modèle de service Global-Plugin-Execution

1. Allez sur l'application web.

2. Créez un nouveau modèle de service.

  • Allez sur le menu Configuration > Services > Liste.
  • Cliquez sur + Ajouter dans l'onglet Mode : Box.

3. Renseignez les informations ci-dessous.

Onglet Informations générales
     Global-Plugin-Execution configuration.png

  • Modèle de service : Sélectionnez le modèle Global-Plugin-Execution.
  • Nom du service : Saisissez le nom du nouveau service unitaire à créer, correspondant au nom de l'événement à capter.

    exemple  Link Down

     

Onglet Disponibilité et contrôles
     Global-Plugin-Execution configuration - Availability and checks tab.png

  • Fichier de plugin à exécuter: Nom du programme.
  • Arguments du plugin : Liste des arguments du programme.
    • Les arguments doivent être passés sous la forme -H ‘valeur’ ou –host ‘valeur’.

      exemple  -c ‘public’ ; –url ‘https://myurl.com’

    • Les valeurs des arguments doivent être encadrées par des guillemets "value" ou des apostrophes 'value'.
    • Pour renseigner une valeur contenant des guillemets dans une instruction encadrée par des guillemets, utilisez le caractère \.

      exemple  -h $HOSTADDRESS$ –URI ‘mylogin.php’ –pwd ‘eyi"kim58’ –text ‘Rue de l'"'"'alma’

    • Pour renseigner une valeur contenant des apostrophes dans une instruction encadrée par des apostrophes, encadrez chaque apostrophe par des guillemets.

      exemple  -h $HOSTADDRESS$ –URI ‘mylogin.php’ –pwd "eyi\"kim58" –text "Rue de l’alma"

    • Vous pouvez utiliser les variables suivantes :
      • $_SERVICEHOSTALIAS$ : Retourne le nom de l’équipement de rattachement du service.
      • $HOSTADDRESS$ : Retourne l’adresse IP de l’équipement de rattachement du service.
      • $_SERVICEDISPLAYNAME$ : Retourne le nom du service tel qu’indiqué dans ServiceNav
      • $_SERVICEIDSERVICE$ : Retourne l’identifiant unique du service.
      • $_HOSTCOMPANYNAME$ : Retourne le nom de la société de rattachement de l’équipement de rattachement du service.
      • $_HOSTHOST_CATEGORY_NAME$ : Retourne le nom de la catégorie d’équipement de rattachement du service.
    • Vous ne pouvez pas utiliser les variables de compte indiquées au niveau de la société et/ou de l’équipement. Vous devez renseigner les informations d’identification nécessaires au programme via le champ Argument du plugin.

4. Enregistrez le nouveau modèle de service via Valider.

Tags :
Powered by XWiki © EasyVista 2022