Concept

La source de type synchronizer-collector-excel permet d'importer via un fichier Excel ( xls ou xlsx ) tous les éléments gérés par Shinken ( hôtes, checks, périodes de temps, etc. 

  • Shinken impose l'agencement des informations dans le fichier Excel ( voir la page Collecteur de type synchronizer_collector_excel ( Pour importer un fichier Excel ) ) :
    • Il doit y avoir un onglet par type d'élément à importer ( hôtes, clusters, etc )
      • Chaque ligne de ces onglets décrit un objet à importer
      • Chaque colonne une information, par exemple le nom d'un hôte, son adresse IP ou le datacenter dans lequel il est hébergé.
    • Il doit y avoir un onglet "Configuration" qui :
      • Décrit pour chaque onglet quel type d'objet Shinken sera importé ( par exemple l'onglet "Équipements à importer" peut contenir des hôtes )
      • Décrit dans quelle propriété de Shinken seront récupérées les informations des différentes colonnes des autres onglets ( par exemple la colonne "Adresse de l'hôte" peut contenir l'adresse IP de l'hôte )
  • Ces éléments peuvent être fusionnés avec les éléments déjà existants dans le Synchronizer grâce au mécanisme de mélange des sources ( voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).

Fonctionnement

Un mapping est une correspondance entre une colonne du fichier Excel et une propriété ou une donnée de Shinken. 

La source fonctionne de la manière suivante :

  1. La source récupère le fichier excel ( xls ou xlsx ) défini dans son fichier de configuration.
  2. La source lit le fichier et récupère les informations sur les éléments qu'elle doit ajouter / modifier dans Shinken.
  3. La source créée les éléments Shinken avec ces informations en appliquant les règles de mapping ( voir la page Mapping vers les propriétés et les données de Shinken - synchronizer-collector-excel ).


Il est conseillé d'utiliser le fichier fourni dans l'installation de Shinken. Ainsi, le fichier Excel aura toujours un format compatible avec la source installée sur le système.

Il est disponible à l'emplacement suivant :

/etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/source-data-synchronizer-collector-excel/Excel-import-file.xlsx

Fichier d'exemple : Excel-import-file.xlsx


Mise en place et configuration de la source

La procédure de mise en place et de configuration de la source est expliqué dans une autre page ( voir la page Collecteur de type synchronizer_collector_excel ( Pour importer un fichier Excel ) ).

Utilisation de la source

Import via la page principale

Une fois créé, le collecteur apparaîtra dans la liste des collecteurs.

Comme pour les autres sources, il vous suffit de cliquer sur le bouton triangle  pour importer les éléments du collecteur ( voir la page Les collecteurs ).

Les différentes étapes lors de l'importation des éléments ainsi que leur progression seront affichées dans la colonne Résultat de la source.

Présentation de l'interface de la source synchronizer-collector-excel

La configuration du collecteur se fait par fichier de définition ( .cfg ou .json ), et son utilisation se fait par l'interface graphique.

  • En cliquant sur le nom de la source, vous ouvrirez l'interface qui lui est dédiée.


Depuis l'interface graphique, il est possible :

  • D'importer la source à partir de l'interface de cette source en cliquant en haut à droite de l'écran sur l'icône ( 1 )
  • De recharger toute modification faite dans les fichiers de définition ( .cfg pour la configuration de la source et .xls ou .xlsx pour le mapping et les données ), en cliquant en haut à gauche sur l'icône ( 2 ) .


Cette interface possède 4 onglets qui permettent de visualiser la configuration de la source et le résultat des imports :

Les quatre pages précédentes détaillent le contenu des onglets.