Page History

Contexte

Cette page a pour but de vous décrire la mise en place du pack linux-by-SNMP__shinken :

• Le déploiement du pack sur votre plateforme,
• La configuration de vos connexions SNMP,La mise en place de pré-requis pour certains checks.

Procédure de mise en place du pack

En préambule, il faut :

1. Récupérer la dernière version du pack auprès de l'équipe Shinken ou de votre partenaire,
2. Transférer le pack sur votre Synchronizer et votre/vos Pollers.

En utilisant l'installeur "install.sh" ( sur Poller / Synchronizer )

Commun à tout Poller / Synchronizer

Que ce soit sur un Synchronizer où sur un Pollers :

1. Désarchiver le pack :

   Code Block
   language bashtext theme Emacs
   tar --no-same-owner -xf NOM_DU_PACK.tar.xz

2. Entrée dans le répertoire extrait de l'archive et lancer le "install.sh"

   Code Block
   language bashtext theme Emacs
   cd NOM_DU_PACK/ ./install.sh

3. L'installeur dépose les éléments suivants :

   • Le fichier de configuration de la source "shinken-additional-packs-import" qui servira à importer la définition du pack dans le Synchronizer.
   • Les fichiers de définitions des éléments du pack, à importer dans le Synchronizer.

   • Les sondes du pack.
     
     Exemple de mise en place :
     
     

     Code Block
     language bashtext theme Emacs
     ======================================================== INSTALL PACK [ linux-by-SNMP__shinken V01.01.00 ]PRE-INSTALLATION CHECKS ======================================================== No previous installation detected. ----------------------------- | COLLECTOR [ shinken-additional-packs-import ] => Adding Collector cfg file - Path : /etc/shinkenProceeding with installation... ======================================================== INSTALL PACK [ linux-by-SNMP__shinken V02.02.00-RC000.03 ] ======================================================== ----------------------------- | COLLECTOR [ shinken-additional-packs-import ] => Collector cfg file already AVAILABLE - Path : /etc/shinken/sources/shinken-additional-packs-import.cfg => Creating Collector DATA space already AVAILABLE - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import => Adding Definition File already AVAILABLE [ definition_shinken-additional-packs-import.cfg ] - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/definition_shinken-additional-packs-import.cfg => Applying permissions - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import - Setting owner ( to "shinken" user ) - Setting rights ----------------------------- | MONITORING DEFINITION: => Installing definitions file in source-data folder ( Collector => shinken-additional-packs-import ) - Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import - Setting owner ( to "shinken" user ) - Setting rights => Installing global data definitions file in SHINKEN directory ( => resource.d ) - Path : /etc/shinken/resource.d/shinken-additional-packs-import/ - Setting owner ( to "shinken" user ) - Setting rights ----------------------------- | PROBES: => Installing probes - Path : /var/lib/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken - Setting owner ( to "shinken" user ) - Setting rights

En suivant, spécifiquement sur le Synchronizer

1. • ========================================================

========================================================
PRE-INSTALLATION CHECKS
========================================================

ERROR: Previous installation detected!

The following files/folders from a previous installation were found:

- /var/lib/shinken-user/libexec/shinken-additional-packs

et en suivant, redémarrez le Synchronizer pour que le collecteur soit pris en compte :

service shinken-synchronizer restart

/linux-by-SNMP__shinken
              - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import

• En suivant, vous devrez peut-être accepter ou des nouveautés ou des différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).

Ou manuellement ( si ne vous voulez pas utiliser l'install.sh )

Commun à tout Poller / Synchronizer

Si vous avez déjà installé le pack

Nous vous conseillons de supprimer les anciens dossiers dans lesquels le pack était présent, pour être sûr d'avoir la dernière version de tous les fichiers livrés.

Pour supprimer ces dossiers, utilisez la commande suivante ( si vous avez suivi à la lettre la procédure d'installation manuelle ) :

rm -rf /var/lib/shinken-user/libexec/packs/linux-by-SNMP__shinken
              - /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux-by-SNMP__shinken
              - /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux-by-SNMP__shinken

Extraire le pack

Transférer sur votre machine et décompressez le fichier contenant le pack à l'aide de la ligne de commande ci-dessous ( en remplaçant "PACK__shinken__NON-DU-PACK__VERSION__OS.tar.gz" par le nom du pack qui vous est livré.

• Pour Linux  ( le paramètre --no-same-owner permet de ne pas conserver les attributs d'utilisateurs/roles présent de la création du pack  ) :

tar -xjfv --no-same-owner PACK__NOM-DU-PACK__shinken__VERSION__linux.tar.xz -C ./

• Pour Windows ( Rôle de Poller ) :

tar -xvzf PACK__NOM-DU-PACK__shinken__VERSION__windows.tar.gz -C ./

Entrez dans le répertoire créér :

cd NOM_DU_PACK/

Les sondes ( mises en place )

On place les sondes :

probe_path="/var/lib/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken"
mkdir --parents $probe_path
cp -r ./probes/* $probe_path
chown -R shinken:shinken $probe_path
chmod -R 750 $probe_path

Sur le Synchronizer

Sur le Synchronizer

1. SEULEMENT si le collecteur "shinken-additional-packs-import" n'est pas déja PRÉSENT dans votre Synchronizer ( par exemple : première fois que vous utilisez un installeur de pack Shinken ) :
   
   Vérifier dans la configuration de votre Synchronizer ( /etc/shinken/synchronizers/synchronizer-master.cfg ) que le collecteur "shinken-additional-packs-import" soit présent dans le champ sources.

   Code Block
   language text theme Emacs
   cat /etc/shinken/synchronizers/synchronizer-master.cfg

   Code Block
   language js theme Confluence
   define synchronizer { [...] sources Source 1, Source 2, Source 3, shinken-additional-packs-import [...] }

   Si le collecteur "shinken-additional-packs-import" n'est pas présent, l'ajouter dans la liste puis redémarrez le Synchronizer pour que le collecteur soit pris en compte :

   Section
   Code Block language text theme Emacs service-shinken-synchronizer restart Note icon false Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante : Code Block language text theme Emacs service shinken-synchronizer restart

   
   

   
   

   
   

2. Activer le collecteur "shinken-additional-packs-import" si ce n'est pas déja fait.
   
   

   Panel
   Image Added

3. Lancer l'import du collecteur "shinken-additional-packs-import":
   
   

   Panel
   Image Added

   
   

   • En suivant, vous devrez peut-être accepter ou des nouveautés ou des différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).
     
     

4. IMPORTANT : si c'est première fois que vous installez le pack, il est nécessaire de faire un dernier redémarrage du Synchronizer.

   Section
   Code Block language text theme Emacs service-shinken-synchronizer restart Note icon false Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante : Code Block language text

Ensuite, plaçons maintenant la définition des éléments de supervision du pack au bon endroit :

Redémarrer shinken

1. theme Emacs service shinken-synchronizer restart

Ou manuellement ( si l'

• En suivant, vous devrez peut-être accepter les nouveautés / différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).

Vous pouvez également supprimer le dossier qui a été créé suite à la décompression du pack en utilisant la commande suivante :

rm -rf ./linux-by-SNMP__shinken

Si vous avez déjà installé une version précédente de ce pack, il vous faudra supprimer les anciens dossiers dans lesquels le pack était présent ( afin d'éviter de garder d'ancien fichier en cas d'évolution de la structure du pack ).

Pour supprimer ces dossiers, utilisez la commande suivante :

rm /etc/shinken/sources/shinken-additional-packs-import.cfg
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/
rm -rf /var/lib/shinken-user/libexec/linux-by-SNMP__shinken/

Comment configurer la connexion SNMP ?

Côté client ( machine ou serveur Linux supervisé )

Sur votre serveur supervisé avec l'OS Linux, il vous faut installer le paquet net-snmp pour configurer un serveur SNMP.

Vous pouvez également installer le paquet net-snmp-utils ( Utilitaires de gestion de réseau utilisant SNMP, issus du projet NET-SNMP ). L'installation de ce paquet est optionnelle pour le fonctionnement du pack.

Ensuite, par précaution, faîtes une copie puis éditez le fichier de configuration de snmpd :

Serveur en SNMPv1 et v2

La ligne suivante permet de changer la communauté public vers une communauté propre à votre réseau et plus ou moins complexe ( remplacez "public" par la chaîne de caractères que vous souhaitez ).

Serveur en SNMPv3

Arretez le service SNMP pour pouvoir lancer la commande de création d'un utilisateur :

service snmpd stop

Créez vote utilisateur avec ses informations d'identification :

net-snmp-create-v3-user -ro -A shinkenpassword -a SHA -X shinkenencryptionkey -x AES shinken

Redémarrez le service SNMP :

service snmpd start

Test de connexion en local :

snmpwalk -u shinken -A shinkenpassword -a SHA -X shinkenencryptionkey -x AES -l authPriv 127.0.0.1 -v3

À noter qu'ici, nous avons défini :

• shinken: nom de l'utilisateur côté serveur SNMPv3
• shinkenpassword: mot de passe de l'utilisateur. Attention : il ne peut pas être plus petit que 8 caractères.
• shinkenencryptionkey: clé de chiffrement pour cet utilisateur
• AES: protocole de chiffrement de l'utilisateur
• SHA: méthode de hashage des informations de l'utilisateur

Ces paramètres sont par défaut dans le pack et seront utilisés dans les modèles de supervisions pour interroger les équipements supervisés. Si vous créez vos propres paramètres, il faudra donc les modifier dans l'interface de configuration.

L'ajout de la ligne "group notConfigGroup usm shinken" est nécessaire pour pouvoir faire fonctionner les modèles d'hôtes  linux-by-SNMPv3_( noAuthNoPriv / authNoPriv / authPriv ).

#       groupName      securityModel securityName
group notConfigGroup v1 notConfigUser
group notConfigGroup v2c notConfigUser
group notConfigGroup usm shinken

Aide au fonctionnement global

Par défaut, le fichier de configuration associe ensuite ( étape 3 dans le fichier ) le nom de sécurité ( "notConfigUser" ) a une vue d'accès restreintes à certains OID ( "systemview" ).
Pour un accès sur l'ensemble des OIDs du système, utilisez une nouvelle vue, par exemple "all":

Et par conséquent, remplacez la vue "systemview" par "all" dans la dernière étape de configuration du fichier :

Vous pouvez maintenant démarrer le démon SNMPD :

Pensez à redémarrer le service snmpd à chaque modification du fichier de configuration snmpd.conf.

Pour un démarrage du service snmpd à chaque démarrage de votre machine, utilisez la commande :

Vous pouvez tester votre service snmpd avec la commande snmpwalk ( changez la communauté si besoin ).

En cas d'erreur : ERROR: Description table : The requested table is empty or does not exist.

utilisation du script install.sh n’est pas souhaitée ) :

Commun à tout Poller / Synchronizer

Si le pack est déjà installé

Il est recommandé de supprimer les anciens dossiers contenant le pack afin de garantir l'utilisation de la dernière version des fichiers livrés.

Pour effectuer cette suppression ( si la procédure d'installation manuelle a été suivie telle quelle ), la commande suivante peut être utilisée :

rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux-by-SNMP__shinken
rm -rf /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux-by-SNMP__shinken

Extraire le pack

Transférer le fichier du pack sur la machine et décompresser le fichier contenant le pack à l'aide de la ligne de commande ci-dessous (remplacer "PACK__shinken__NOM-DU-PACK__VERSION__OS.tar.gz" par le nom exact du pack livré) :

• Pour Linux  ( le paramètre --no-same-owner permet de ne pas conserver les attributs d'utilisateurs/roles présent de la création du pack  ) :

tar -xjfv --no-same-owner PACK__NOM-DU-PACK__shinken__VERSION__linux.tar.xz -C ./

• Pour Windows ( Rôle de Poller ) :

tar -xvzf PACK__NOM-DU-PACK__shinken__VERSION__windows.tar.gz -C ./

Entrez dans le répertoire créér :

cd NOM_DU_PACK/

Les sondes ( mises en place )

On place les sondes :

probe_path="/var/lib/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken"
mkdir --parents $probe_path
cp -r ./probes/* $probe_path
chown -R shinken:shinken $probe_path
chmod -R 750 $probe_path

Sur le Synchronizer

Ensuite, plaçons maintenant la définition des éléments de supervision du pack au bon endroit :

• Les fichiers de configuration :
  • Nous vous conseillons de créer un Collecteur de type ( cfg-file-import ) qui permet d'importer des définitions d'éléments Shinken depuis les fichiers de définitions présents dans ce pack.
    
    • Vous trouverez la procédure de mise en place dans la page de documentation suivante ( Collecteur de type ( cfg-file-import ) - Import depuis des fichiers au format .cfg )
    • Pour la suite des explications, nous considérerons que ce collecteur s'appelle "shinken-additional-packs-import"

  • Une fois le collecteur mis en place, nous allons déployer le pack au bon endroit :

    • En premier, les fichiers de définition des éléments ( modèles d'hôtes, checks, commandes, ... )  du pack :

      Code Block
      language text theme Emacs
      shinken_collector_data_path="/etc/shinken-user/source-data/source-data-shinken-additional-packs-import" cp -r ./monitoring-definitions/packs/* $shinken_collector_data_path chown -R shinken:shinken $shinken_collector_data_path chmod -R 744 $shinken_collector_data_path

    • Ensuite, les données globales

      Code Block
      language text theme Emacs
      shinken_pack_globaldata_path="/etc/shinken/resource.d/shinken-additional-packs-import" mkdir --parents $shinken_pack_globaldata_path cp -r "./monitoring-definitions/global-data" "$shinken_pack_globaldata_path" chown -R shinken:shinken "$shinken_pack_globaldata_path" chmod -R 744 "$shinken_pack_globaldata_path"

• Redémarrer shinken

  Section
  Code Block language text theme Emacs service-shinken-synchronizer restart Note icon false Pour les versions de shinken strictement inférieures à V02.08.02-RC018.05, il faudra utiliser la commande suivante : Code Block language text theme Emacs service shinken-synchronizer restart

•  Activer le collecteur  "shinken-additional-packs-import" :

  Panel
  Image Added

• Lancer l'import du collecteur "shinken-additional-packs-import" :

  Panel
  Image Added

  
  

  • En suivant, vous devrez peut-être accepter les nouveautés / différences qui seraient liés à ce pack ( en fonction de l'évolution du pack ).
    
    

• IMPORTANT : si c'est première fois que vous installez le pack, il est nécessaire de faire un dernier redémarrage du Synchronizer.

  Section
  Code Block language text theme Emacs service-shinken-synchronizer restart Note icon false Pour les versions de shinken strictement inferieur à V02.08.02-RC018.05, il faudra utiliser la commande suivante : Code Block language text theme Emacs service shinken-synchronizer restart

  
  

Vous pouvez également supprimer le dossier qui a été créé suite à la décompression du pack en utilisant la commande suivante :

rm -rf ./linux-by-SNMP__shinken

Si une version précédente du pack a déjà été installée, il est recommandé de supprimer les anciens dossiers pour éviter de conserver des fichiers obsolètes, notamment en cas de modification de la structure du pack.

Utiliser les commandes suivantes pour effectuer cette suppression :

rm -rf /var/lib/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken
rm -rf /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux-by-SNMP__shinken
rm -rf /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux-by-SNMP__shinken

Comment configurer la connexion SNMP ?

Pour l'exécution correcte des commandes du pack linux-by-SNMP__shinken, vous aurez besoin d'installer, d'activer ou de paramétrer le serveur SNMP sur la machine linux supervisée.

Quelques informations au préalable sont nécessaires pour la bonne compréhension de cette partie.

Il faudra en premier lieu définir les méthodes de connexion sur les machines Linux supervisées :

• SNMPv3 : pour utiliser les modèles d'hôtes linux-by-SNMPv3__( noAuthNoPriv / authNoPriv / authPriv ), il faudra définir :
  • un utilisateur, un mot de passe, une clé de chiffrement pour cet utilisateur, un protocole de chiffrement pour celui-ciet une méthode de hashage pour ses informations.
  • Des données sont prévues à cet effet.
• SNMPv2 : pour utiliser les modèles d'hôtes linux-by-SNMPv1v2, il faudra définir :
  • une communauté.
  • Des données sont prévues à cet effet.

Nous conseillons l'utilisation d'un utilisateur spécifique ( pour le service de supervision ).

Côté du serveur Linux supervisé ( configurer le SNMP ) 

Pour savoir comment configurer SNMP sur les équipements à superviser, voir la page Configuration du serveur Linux supervisé via le pack linux-by-SNMP__shinken.

Côté serveur Poller

Une configuration est nécessaire seulement si vous avez plusieurs Pollers dans un même royaume.

• En effet, les checks ont la nécessité de stocker des fichiers temporaires d'une exécution sur l'autre.
• mais comme le même check peut être exécuté sur le Poller 1 et en suivant sur le Poller 2, il est nécessaire que les 2 Pollers puissent accéder chacun au même fichier temporaire.

Créer

Côté serveur Poller

Les scripts sont exécutés par le ou les serveurs Poller.

• Les commandes sont basées sur des scripts PERL.
• Pour information, les librairies suivantes sont nécessaires :
  • Déjà installé par l'installeur de Shinken :
    • Perl 
    • net-snmp-utils
    • net-snmp-libs.
  • Nécessaire pour SNMP V3 :

    • perl-Crypt-Rijndael ( que vous devez rajouter sur votre OS ) ( Installation ici  ou avec la ligne de commande suivante : )

	# Installation de la librarie cryptographique
    sudo yum install perl-Crypt-Rijndael

Côté interface de configuration

Modèle d'hôtes linux-by-SNMPv1v2

Modèle d'hôtes linux-by-SNMPv3_( noAuthNoPriv / authNoPriv / authPriv )

Commun à tout les modes de connexion

linux-by-SNMPv3__noAuthNoPriv

Pas de données communes supplémentaires pour ce mode de connexion

linux-by-SNMPv3__authNoPriv

linux-by-SNMPv3__authPriv

Données communes

Entrée dans le répertoire extrait de l'archive et lancer le "uninstall.sh"

cd linux-by-SNMP__shinken
./uninstall.sh

Ce mécanisme va seulement enlever les fichiers mis en place lors de l'installation ( Fichier du collecteur d'import, définition des éléments de supervision, et les sondes proposées ), mais ne touchent pas aux éléments que vous avez absorbés dans le Synchronizer.

extrait de l'archive et lancer le "uninstall.sh"

cd linux-by-SNMP__shinken
./uninstall.sh

Ce mécanisme va seulement enlever les fichiers mis en place lors de l'installation ( Fichier du collecteur d'import, définition des éléments de supervision, et les sondes proposées ), mais ne touchent pas aux éléments que vous avez absorbés dans le Synchronizer.

==========================================================
UNINSTALL PACK [ linux-by-SNMP__shinken V01.01.00 ]
==========================================================

-----------------------------
| MONITORING DEFINITION:

=> Deleting pack monitoring definition folder
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken

=> Deleting pack monitoring definition file
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken.pack

=> Deleting pack monitoring globaldata folder
- Path : /etc/shinken-user/source-data/source-data-shinken-additional-packs-import/global-data/linux-by-SNMP__shinken

=> Deleting shinken pack globaldata folder
- Path : /etc/shinken/resource.d/shinken-additional-packs-import/global-data/linux-by-SNMP__shinken/


===================================
UNINSTALL PACK [ linux-by-SNMP__shinken V02.00.00-RC000.02 ]
==========================================================

    -----------------------------
    |   MONITORING PROBESDEFINITION:

        => Deleting probes
pack monitoring definition folder
              - Path : /var/libetc/shinken-user/libexec/shinken-additional-packs/linux-by-SNMP__shinken


==========================================================
PACK [ source-data/source-data-shinken-additional-packs-import/packs/linux-by-SNMP__shinken

 V01.01.00 ] SUCCESSFULLY UNINSTALLED
==========================================================

Pré-requis pour certains checks

Disks Usage by SNMPvX

Le check Disks Usage by SNMP utilise le protocole SNMP pour collecter des informations sur l’utilisation des disques. Cependant, dans certains cas, il peut échouer à récupérer ces informations. Cela se produit généralement lorsque les disques ne sont pas explicitement inclus dans la configuration SNMP ou lorsqu'ils ne sont pas détectés automatiquement.

En cas d'erreur : No disks found.

Arretez le service SNMP  :

service snmpd stop

Ouvrez le fichier de configuration SNMP

vim /etc/snmp/snmpd.conf

Rajoutez cette ligne dans la partie dédiée aux disques : includeAllDisks 10%

###############################################################################
# disk checks
#

# The agent can check the amount of available disk space, and make
# sure it is above a set limit.

# disk PATH [MIN=100000]
#
# PATH:  mount path to the disk in question.
# MIN:   Disks with space below this value will have the Mib's errorFlag set.
#        Default value = 100000.

# Check the / partition and make sure it contains at least 10 megs.


includeAllDisks 10%

Redémarrez le service SNMP  :

service snmpd start

Network Interfaces by SNMPvX

Ce check requiert un accès spécifique au dossier /tmp/shinken. Pour ce faire, nous vous mettons à disposition une série de commandes. Ces commandes permettront au groupe de l'utilisateur choisi ( exemple : shinken ) pour votre supervision Shinken d'avoir un accès au dossier /tmp/shinken.

Commandes à éxecuter :

shinken_tmp_dirname="shinken"
mkdir --parents /tmp/$shinken_tmp_dirname
chown root:shinken /tmp/$shinken_tmp_dirname
chmod g+rwx /tmp/$shinken_tmp_dirname

Erreurs lors de l'utilisation du pack

Pour toute erreur survenue lors de l'exécution des checks, voir la page Erreurs du pack linux-by-SNMP__

1. La commande mkdir --parents  /tmp/shinken créer récursivement le répertoire /tmp/shinken.

1. La commande chown root:shinken /tmp/shinken modifie le groupe du dossier /tmp/shinken.

• Cela garantit que des droits peuvent être appliqués au groupe shinken sur ce dossier.

2. La commande chmod g+rwx /tmp/shinken applique immédiatement les droits nécessaires au dossier /tmp/shinken pour le groupe shinken.