Comment créer sa propre source

Chemin des fichiers

Avant de pouvoir importer des éléments, les sources nécessitent d'être préalablement configurées. 

  • Chaque source est définie par un fichier de configuration contenant différentes propriétés tel que l'adresse de serveurs distants, des identifiants, ou d'autres informations.
  • Certaines sources sont pré-configurées, comme par exemple la source Nagios.
    • Ces sources sont des sources d'exemple pour vous aider à prendre en main la configuration des sources.


  • Pour connaître l'emplacement de ce fichier et des informations à définir, référez-vous à la documentation de chaque type de source.
  • Il est recommandé de ne jamais directement modifier les sources d'exemple proposées, mais plutôt de les copier puis les renommer pour créer une nouvelle source ( ceci est détaillé dans la configuration de chaque source ). 


Structure de base d'un fichier de source

Chaque source contient un certain nombre d'options communes à toutes les sources et d'autres spécifiques au fonctionnement d'un type de source en particulier ( exemple : les écouteurs ).

Toutes les sources partagent les champs suivants:

Nom de l'optionValeurs possiblesEffet sur le fonctionnement de la source
source_name ou listener_name ou analyser_name< un nom >Sera le nom affiché de la source dans l'interface. Ce nom ne doit pas dépasser 40 caractères. Un nom trop long empêchera le Synchronizer de démarrer.
module_type< un nom de module >Définit quel est le type de source, par exemple cfg-file-import pour un import de fichier.
import_interval< un entier >Définis à quel intervalle, en minutes, l'import de la source est activé. 0 signifie activation manuelle uniquement.
enabled< 0 ou 1 >Définis si la source est activée. L'import d'une source activée aura lieu régulièrement, selon l'import_interval.
order< un entier >Définis l'ordre de priorité de la source. Il est préférable d'utiliser l'interface plutôt que le fichier pour définir ce paramètre.
description< une description >Une description optionnelle de la source.
cfg_path< un chemin >Chemin vers le fichier de configuration principal nagios/shinken qui relie toutes les définitions d’objets
not_stored_properties< liste de champs >Ce paramètre permet de définir un ou plusieurs champs qui ne seront pas importés dans Shinken. Cela peut être utile pour exclure une propriété ou bien utiliser des champs personnalisés utiles pour la gestion de vos fichiers .cfg
put_in
  • source_space
  • staging
  • production
  • production_and_reload_arbiter


Permets de pousser les différences et les nouveaux éléments de cette source directement en Staging ou Production ou bien de les laisser dans l'espace de calcul des sources comme par défaut.

Remplace l'ancien paramètre put_in_staging

put_in_user< un nom d'administrateur Shinken >

Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.

Remplace l'ancien paramètre put_in_staging_user


Les différents types de sources ( module_type ) fournis par Shinken Enterprise déterminent quelles seront les autres options spécifiques au module, qui seront présentes dans la configuration.

  • Par exemple, une source d'import de fichier nécessite un chemin vers des fichiers de configuration.
  • Certaines sources plus complexes ( LDAP, Active directory, VMWare, etc... ) nécessitent des fichiers supplémentaires de configuration, qui seront également listés en tant qu'option.


Afficher la source dans l'interface

Pour afficher votre source dans l'interface de configuration, il faut modifier le fichier de votre Synchronizer dans le répertoire /etc/shinken/synchronizers/. 

  • Dans le fichier Synchronizer, ajouter au paramètre "sources", le nom de votre source. 


  • Si vous supprimez une source sans retirer son nom de la liste cela empêchera le démon Synchronizer de démarrer.

  • Pour que cette modification soit prise en compte, il faut redémarrer le Synchronizer.

  • Si vous souhaitez masquer ou supprimer la source, il est impératif d'enlever le nom de la source de cette liste.


Comment organiser ses sources ( ré-ordonnancement )


  • Ordre ( clé de configuration order ) : Ordre des priorités des mélanges entre les différentes sources. 
  • ré ordonnancement : c'est l'action de changer l'ordre de l'ensemble des sources.
    • Les sources ayant l'ordre le plus petit ( le plus proche de 1 ) seront prioritaires lors du mélange des sources, lors de la fusion d'un élément.

Par exemple si une source avec une priorité ( 1 ) importe un hôte qui possède la description "description 1" et que le même hôte ( clé de synchronisation qui correspondent ) provenant d'une source avec une priorité ( 2 ) possède la description "description 2", lors de la fusion, la description de la source ( 1 ) sera gardé et celui de la source ( 2 ) sera ignoré.


Quel que soit le type de source configurée, il est possible de les réordonner afin de prioriser l'import d'une source par rapport à une autre.

Cela peut être défini dans les fichiers de définitions des sources avec le paramètre de configuration "order", mais il est préférable de le réaliser sur l'interface. (Permet de ne pas avoir à redémarrer le Synchronizer)

Pour cela, sur la page principale, dans la zone des modules de détection et qualification :

  • Cliquez sur le bouton Changer l'ordre des sources (1)






  • Une fois en mode Changer l'ordre des sources, la liste de toutes les sources ( quel que soit leur type ) est affichée en fonction de l'ordre de priorité
  • Pour changer l'ordre de la source, sélectionnez la ligne de celle-ci en maintenant le clic à l'aide de souris et faite un glissez et déposer vers l'endroit où vous souhaitez la déplacer.



  • Une fois la source relâchée, un clignotement bleu dans la colonne "Ordre" vous indique que le changement d'ordre a eu lieu ( 2 ).
  • Vous pouvez revenir sur la vue des sources rangé par type en cliquant sur "Voir les sources par type" ( 3 ).