Concept

La configuration du collecteur, définie dans le fichier de configuration de la source ( voir la page Collecteur de type synchronizer_collector_excel ( Pour importer un fichier Excel ) ) peut être consultée dans l'onglet "Configuration", dont les différentes parties sont décrites ci-dessous.


Cet onglet est divisé en 5 chapitres :

Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( → sera implémenté dans une prochaine version )

Les différentes parties de l'onglet

1 - Configuration générale

NomTypeUnitéDéfautDescription
Nom
Texte------

Nom de la source affichée dans la page d'accueil de l'interface de configuration.

  • Doit être unique ( parmi toutes les sources )
  • D'une longueur inférieure à 40 caractères
  • Ne doit pas contenir le caractère "$"

Nom dans le fichier cfg : source_name

Type de Module
Texte---synchronizer_collector_excel

Type de module chargé par le Synchroniser. 
À ne pas modifier 

Nom dans le fichier cfg : module_type

Description
Texte------

Un texte décrivant le collecteur 

Nom dans le fichier cfg : description

Intervalle d'Import
EntierMinute 0

Délai écoulé entre les imports automatiques de la source. 

  • Un nombre
  • Si 0, la source ne sera jamais importée automatiquement.

Nom dans le fichier cfg : import_interval

Ordre
Entier------

L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).

Remarque : Si l'ordre est changé depuis l'interface ( page d’accueil ), le fichier cfg sera mis à jour.

Nom dans le fichier cfg : order

Éléments Shinken importés
Texte------

Liste des types d'éléments à importer au format Shinken lors de l'import de la source.

Par défaut, tous les types d'éléments sont affichés.

Nom dans le fichier cfg : type_to_import

2 - Options de mélange des sources

NomTypeUnitéDéfautDescription
Mode de mélange des sources
Texte---Toutes

Définit le mode de mélange entre les éléments récupérés de cette source et les autres sources.


Valeurs possibles :

Nom dans l'interfaceValeurs dans le fichierDescription

Ne fusionne pas avec les autres

dont_merge_with_other

Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources.

S'il existe le même élément importé par une autre source, les éléments ne seront pas importés.

Seulement avec "Syncui"

only_with_syncui

Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément.

Tout sauf Syncui

all_without_syncui

Si un même élément est importé par plusieurs sources ( à part "Syncui" ), alors les éléments seront fusionnés pour n'en donner qu'un.

Toutes

all

Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un.


Pour plus de détails sur ce paramètre, se référer au chapitre : Mode de mélange des sources

Paramètre dans le fichier cfg : merge_mode

Détecter les nouveaux éléments
Texte---Activé

Les éléments proposés par la source sont soumis au calcul des nouveautés par rapport à l'espace de données "Staging".


Valeurs possibles :

Nom dans l'interfaceValeurs dans le fichierDescription
Activé authorizedLe mécanisme de calcul des nouveautés analysera les éléments de la source pour identifier les nouveaux éléments par rapport à l'espace de données Staging.
Désactivé never_newLes éléments de la source n’apparaîtront pas comme Nouveau, même s'ils n'ont jamais été importés dans l'espace de données Staging.

Paramètre dans le fichier cfg : compute_new_element

Calculer les différences
Texte---Activé

Les éléments proposés par la source sont soumis au calcul des différences par rapport à l'espace de données "Staging".


Valeurs possibles :

Nom dans l'interfaceValeurs dans le fichierDescription
Activé authorizedLe mécanisme de calcul des différences analysera les éléments de la source pour calculer les différences par rapport à l'espace de données Staging.
Désactivé never_differenceLes éléments de la source n’apparaîtront pas comme Différence, même s'ils possèdent des différences par rapport à la version présente dans l'espace de données Staging.

Paramètre dans le fichier cfg : compute_element_difference

Détecter les éléments qui ne sont plus présents dans la source
Texte---Désactivé

Permets de proposer, en suppression, les éléments qui ne sont plus présents dans la source.

Si le dépôt des éléments est paramétré pour aller dans l'espace de calcul des Sources, le calcul de suppression des éléments ne pourra pas se faire.

Valeurs possibles :

Nom dans l'interfaceValeurs dans le fichierDescription
Désactivé 

disabled

Les éléments qui ne sont plus présents dans la source ne seront pas proposés à la suppression.

Supprimer s'ils ne sont pas dans cette source

delete_if_missing_in_this_source

Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression.

Supprimer s'ils ne sont pas dans TOUTES les sources

delete_if_missing_in_all_sources 

Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources ( sauf syncui ), seront proposés à la suppression.


Paramètre dans le fichier cfg : compute_deleted_element_not_in_source



Options de mélange des sources - Précisions

Mode de mélange des sources

Ce paramètre sert à définir le mode de mélange entre les éléments récupérés de cette source et les autres sources.


Valeurs possibles :

  • Ne fusionne pas avec les autres :
    • Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources. S'il existe le même élément importé par une autre source, les éléments ne seront pas importés.

  • Seulement avec "Syncui" :
    • Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément.

  • Tout sauf Syncui :
    • Si un même élément est importé par plusieurs sources ( à part "Syncui" ), alors les éléments seront fusionnés pour n'en donner qu'un.

  • Toutes :
    • Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un.


Syncui est une source qui importe tous les éléments de l'interface de configuration.

  • Chaque fois qu'une source est importée, elle l'est aussi.
  • Si cette source ne se mélange pas avec Syncui, les modifications ne seront pas prises en compte sur l'interface de configuration.
Les sources désactivées ne sont pas prises en compte lors du mélange des sources.

Détecter les éléments qui ne sont plus présents dans la source

Ce paramètre permet de proposer en suppression les éléments qui ne sont plus présents dans la source. 


Si le dépôt des éléments est paramétré pour aller dans l'espace de calcul des Sources, le calcul de suppression des éléments ne pourra pas se faire.


Les différentes valeurs possibles sont :

  • Désactiver ( disabled )
    • Les éléments qui ne sont plus présents dans la source ne seront pas proposés à la suppression.

  • Supprimer s'ils ne sont pas dans cette source ( delete_if_missing_in_this_source ) :

    • Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression.

      Même si l'élément est présent dans une autre source, il sera proposé à la suppression.
  • Supprimer s'ils ne sont pas dans TOUTES les sources ( delete_if_missing_in_all_sources ) :

    • Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources (sauf Syncui), seront proposés à la suppression.

      Si l'élément était présent sur deux sources, qu'il a été supprimé uniquement sur cette source, il ne sera pas proposé à la suppression.

3 - Choix de l'espace où seront placés les éléments importés

NomTypeUnitéDéfautDescription
Mettre dans l'espace
Texte--- Espace de calcul des Sources

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


Valeurs possibles :

Nom dans l'interfaceValeurs dans le fichierDescription
Espace de calcul des Sourcessource_space Les éléments sont sauvegardés dans l'espace de données "Sources". Cet espace sera comparé avec l'espace de données "Staging" afin de calculer les nouveautés et les différences.
Staging staging Les éléments sont sauvegardés dans les espaces de données "Sources" et "Staging".
Production production Les éléments sont sauvegardés dans les espaces de données "Sources", "Staging" et "Production". Les changements ne seront pas soumis à la supervision tant que l'Arbiter ne sera pas redémarré.
Production et rechargement de l'Arbiterproduction_and_reload_arbiter Les éléments sont sauvegardés dans les espaces de données "Sources", "Staging" et "Production". L'Arbiter est redémarré afin de soumettre les changements à la supervision.


Pour plus de détails sur ce paramètre, se référer au chapitre Mettre dans l'espace - Précisions

Paramètre dans le fichier cfg : put_in

Utilisateur utilisé pour la sauvegarde des changements
Texte--- shinken-core

Les modifications faites par la source en Staging ou en Production lors de son import ( ajout de nouveau élément ou application de différence ) seront indiquées comme faites par cet utilisateur.

L'utilisateur doit obligatoirement être un administrateur Shinken.

Paramètre dans le fichier cfg : put_in_user

Mettre dans l'espace - Précisions

Cette option permet de choisir où appliquer les différences et d'importer les nouveaux éléments de cette source :

  • Dans l'espace de calcul des sources comme ( par défaut ),
  • Directement en Staging,
  • Directement en Production :
    • Avec rechargement du démon Arbiter ( pour soumettre les changements à la supervision ).
    • Sans rechargement du démon Arbiter.


Le calcul des nouveautés dépend du réglage de la propriété "Détecter les nouveaux éléments".
Le calcul des différences dépend du réglage de la propriété "Détecter les différences".
Le calcul des suppressions dépend du réglage de la propriété "Détecter les éléments qui ne sont plus présents dans la source".



Les valeurs possibles de cette option sont :

  • Espace de calcul des Sources
      • Valeur dans le fichier cfg : source_space
      • Les éléments sont sauvegardés dans l'espace de données "Sources". Cet espace sera comparé avec l'espace de données "Staging" afin de calculer les nouveautés et les différences.
  • Staging
    • Valeur dans le fichier cfg : staging
    • Les éléments sont sauvegardés dans les espaces de données "Sources" et "Staging".

  • Production
    • Valeur dans le fichier cfg : production
    • Les éléments sont sauvegardés dans les espaces de données "Sources", "Staging" et "Production". Les changements ne seront pas soumis à la supervision tant que l'Arbiter ne sera pas redémarré.

  • Production et rechargement de l'Arbiter
    • Valeur dans le fichier cfg : production_and_reload_arbiter
    • Les éléments sont sauvegardés dans les espaces de données "Sources", "Staging" et "Production". L'Arbiter est redémarré afin de soumettre les changements à la supervision.


Après modification de la valeur de ce paramètre, une demande de confirmation sera demandée. ( Voir la section "Besoin de confirmation" )

Une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter" n'appliquera en production que les changements qui proviennent de la source, donc tous les changements visibles dans la page de production ne seront pas appliqués.

Si un utilisateur supprime un élément importé par une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter" alors que l'élément est réimporté par la source, il y aura en production deux éléments avec le même nom, car la suppression manuelle de l'élément ne sera pas prise en compte, ce qui provoquera une erreur.

Une source avec l'option put_in à production_and_reload_arbiter ne redémarrera l'Arbiter que si elle a des modifications à pousser en production.

4 - Clés spécifiques à la source

NomTypeUnitéDéfautDescription
Fichier Excel
Texte--- ---

Chemin d'accès au fichier Excel à charger.

Paramètre dans le fichier cfg : excel_file_path

5 - Clés de synchronisation

Les clés de synchronisation sont des valeurs utilisées lors de l'étape du mélange des sources ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ) qui permet de choisir quel élément de cette source se mélange avec quel élément d'une autre source ( voir la page Le mélange des sources & les clés de synchronisation (sync-key)  ).

Les paramètres :

  • properties_used_as_synckey_for_hosts
  • properties_used_as_synckey_for_clusters
  • properties_used_as_synckey_for_clustertpls
  • properties_used_as_synckey_for_hosts
  • properties_used_as_synckey_for_hosttpls
  • properties_used_as_synckey_for_hostgroups
  • properties_used_as_synckey_for_serviceshosts
  • properties_used_as_synckey_for_serviceshosttpls
  • properties_used_as_synckey_for_servicesclusters
  • properties_used_as_synckey_for_servicesclustertpls
  • properties_used_as_synckey_for_servicetpls
  • properties_used_as_synckey_for_contacts
  • properties_used_as_synckey_for_contacttpls
  • properties_used_as_synckey_for_contactgroups
  • properties_used_as_synckey_for_escalations
  • properties_used_as_synckey_for_notificationways
  • properties_used_as_synckey_for_commands
  • properties_used_as_synckey_for_businessimpactmodulations
  • properties_used_as_synckey_for_macromodulations
  • properties_used_as_synckey_for_resultmodulations
  • properties_used_as_synckey_for_timeperiods

de la source permettent d'ajouter les propriétés qui serviront à créer les clés de synchronisation ( voir la page Collecteur de type synchronizer_collector_excel ( Pour importer un fichier Excel ) ).

Besoin de confirmation

Lorsqu'une modification de la configuration de la source est faite, elle peut impacter les éléments importés avec l'ancienne configuration.

  • Par exemple, ils seront automatiquement supprimés, si la suppression automatique a été activée ou si elle l'est dans le futur.
  • Pour pallier ce problème,
    • Une demande de confirmation apparaîtra si la nouvelle configuration de source impacte ou pourra impacter les éléments précédemment importés.
    • Cette demande de confirmation s'active lorsque la valeur du paramètre "Mettre dans l'espace" ( put_in ) est différente de "Espace de calcul des sources".

Liste des paramètres pouvant déclencher la demande de confirmation :

  • Détecter les nouveaux éléments ( compute_new_element )
  • Calculer les différences ( compute_element_difference )
  • Détecter les éléments qui ne sont plus présents dans la source ( compute_deleted_element_not_in_source )
  • Mettre dans l'espace ( put_in )

Erreurs de configuration

Dans le cas où une clé non reconnue par Shinken est renseignée dans la configuration de la source, une erreur apparaîtra.

  • Cette erreur rendra l'import de la source impossible.