| Scroll Ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Présentation
L'onglet de configuration afficher les paramètres de configuration définies dans le fichier de configuration de votre module peut être consultée dans cet onglet ( voir la page Module de source Collecteur de type cfg-file-import ( format Shinken ou nagios ) ) :
Elle est divisée en 5 chapitres :
- Configuration générale
- Options de mélange des sources
- Dépôts des éléments importés
- Paramètres spécifiques à la source
- Clé de synchronisation ( sync_key )
Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( => Sera implémenté dans une prochaine version )
Configuration générale
| Panel |
|---|
|
Ce chapitre contient tous les paramètres pour le chargement et fonctionnement des sources en général.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||
|---|---|---|---|---|
| Modules |
| Nom de la source affichée dans l'interface de configuration en page d'accueil.
| ||
| Type de Module |
| Type de module chargé par le Synchroniser. Pour cette source le module_type est "cfg-file-import". | ||
| Intervalle d'import |
| Délai écoulé entre les imports automatiques de la source.
| ||
| Ordre |
| L'ordre de la source dans l'interface de configuration, qui a un impact dans la fusion des données lors des imports de sources.
Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier cfg sera mis à jour. |
Options de mélange des sources
| Panel |
|---|
|
Mode de mélange des sources
Grâce au paramètre "Mode de mélange des sources" ( merge_mode dans le fichier de configuration de la source ) il est possible de modifier comment est gérée une source lors de l'étape du mélange des sources.
Voir la page : HIDDEN - V02.08.02 - Le mélange des sources & les clés de synchronisation (sync-key) Concept général et utilisation des sources
La valeur par défaut est : all
Les valeurs possibles sont :
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| merge_mode |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| 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. Ce qui implique que si un élément de cette source possède une clé de synchronisation commune avec une autre source alors ces éléments ne pourront être importés et provoquera un conflit. A utiliser si votre source vous donne un élément complet et qui ne doit pas être modifié ni par l'interface de configuration ni d'autre sources. | ||||
| 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. A utiliser si votre source vous donne un élément complet et que vous vous voulez le modifier via l'interface de configuration. | ||||
| 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. A utiliser si votre source vous donne un élément à compléter avec d'autres sources mais qui ne doit pas être modifié par l'interface de configuration. | ||||
| Toutes | all (valeur par défaut) | Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un. Cas par défaut : les éléments de cette source seront complétés avec les autres sources et l'interface de configuration. | ||||
| Info |
|---|
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 une source ne se mélange pas avec Syncui, les modifications sur l'interface de configuration ne seront pas prises en compte . |
| Info |
|---|
Les sources désactivés ne sont pas prises en compte lors du mélange des sources. |
Détecter les nouveaux éléments
Les éléments proposés par la source sont soumis au calcul des nouveautés ( cf. Les Modules de détection et de qualification ).
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| compute_new_element |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| coché | authorized (valeur par défaut) | Activée => le 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. | ||||
| non coché | never_new | Désactivée => les éléments de la source n’apparaîtront pas en tant que nouveau, même s'ils n'ont jamais été importés par rapport à l'espace de données Staging. | ||||
Calculer les différences
Les éléments proposés par la source sont soumis au calcul des différences ( cf. Les Modules de détection et de qualification).
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| compute_element_difference |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| cochée | authorized (valeur par défaut) | Activée => le mécanisme de calcul des différences analysera les éléments de la source pour identifier toute différence par rapport à l'espace de données Staging. | ||||
| non cochée | never_difference | Désactivée => les éléments de la source n’apparaîtront pas en tant que différence, même s'ils possèdent des différences par rapport a l'espace de données Staging. | ||||
Suppression des éléments absents
Détecter les éléments qui ne sont plus présent dans la source
Permets de proposer en suppression, les éléments qui ne sont plus présents dans la ou les source/s.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
compute_deleted_element_not _in_source |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Désactivé | disabled (valeur par défaut) | Les éléments qui ne sont plus présents dans la(les) source(s) ne seront pas 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. | ||||
| 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. | ||||
Dépôt des éléments après l'import
| Panel |
|---|
|
Mettre dans l'espace
Permets d'appliquer les différences et d'importer 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.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| put_in |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Espace de calcul des Sources | source_space (valeur par défaut) | Les éléments sont sauvegardés dans l'espace de donnée "Sources". Cette espace sera comparée 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 "Espace de calcul des Sources" et "Staging". | ||||
| Production | production | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
| Production et rechargement de l'Arbiter | production_and_reload_arbiter | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
| Info |
|---|
À noter: Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" ne poussera en production que les changements qui proviennent de la source et non tous les changements à appliquer en production (tous les changements visibles dans la page de production). Ce qui implique que si un utilisateur supprime un élément importer 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 2 é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. |
Utilisateur utilisé pour la sauvegarde des changements
Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.
| Info |
|---|
À Noter: l'utilisateur doit être obligatoirement un administrateur Shinken. |
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Valeurs dans le fichier | Description | ||
|---|---|---|---|---|---|
| put_in_user |
| shinken-core | Les nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur faisant la dernière modification. |
Clés spécifiques à la source
| Panel |
|---|
|
Ce chapitre liste tous les paramètres qui sont spécifiques au fonctionnement de cette source.
| Anchor | ||||
|---|---|---|---|---|
|
Configuration du fichier de définition des données de la source
Le fichier de définition des données de la source est le fichier qui est désigné par le cfg_path dans la configuration de la source. Ce fichier doit être unique, mais il permet de définir plusieurs emplacements à importer.
Il présente trois paramètres :
| paramètre | Exemple | Description |
|---|---|---|
| cfg_dir | cfg_dir=. | Il permet d'indiquer à Shinken de lire le contenu d'un dossier et de ses sous-dossiers. Tous les fichiers se terminant par .cfg seront lu et importé par cette source. |
| cfg_file | cfg_file=mes_hotes.cfg | Il permet d'indiquer un seul fichier à lire. Ce n'est pas obliger de se terminer par .cfg, mais il doit en conserver la syntaxe |
| resource_file | resource_file=mon_infrastructure | Il permet d'indiquer un seul fichier à lire. Ce n'est pas obliger de se terminer par .cfg, mais il doit en conserver la syntaxe |
Ces paramètres peuvent être cumulés afin de lire plusieurs répertoires ou plusieurs fichiers.
Voici un exemple de ce fichier de définition qui permet de lire les dossiers et fichiers suivants :
- elements_prod_Paris
- elements_prod_Marseille
- infratrucure_reseau
Si d'autres dossiers ou fichiers sont présents dans le répertoire de données de la source, ils ne seront pas lus dans cet exemple.
| Code Block | ||||
|---|---|---|---|---|
| ||||
cfg_dir=elements_prod_Paris cfg_dir=elements_prod_Marseille cfg_file=infratrucure_reseau |
| Info |
|---|
La syntaxe des fichiers importé par ces définition est rédigée dans cette page : Syntaxe des fichiers d'imports |
Import de fichiers de données globales
Pour une organisation plus facile et une configuration plus propre, les données globales peuvent également être configurées dans les sources.
- Le dossier d'exemple d'une source cfg est situé dans /etc/shinken-user-example/configuration/daemons/synchronizers/sources/cfg-file-import/source-data__cfg-file-import__example et contient un dossier global-data dans lequel les définitions des données globales peuvent être placées (un fichier échantillon est également présent dans ce dossier)
- Lorsque la source est importée, ces fichiers de données globales seront copiés dans /etc/shinken/resource.d/source_name
Ce mécanisme vous permet également de surcharger les valeurs définies dans /etc/shinken/resource.d avec des fichiers définis dans les sources.
Par contre, ces fichiers contenant des définitions de donnée globale ne sont pris en compte qu’après le rechargement du Synchronizer.
Création d'un SE_UUID pour chaque élément de la source
Si vous souhaitez importer des éléments et que ceux-ci ne se mélangent pas avec les éléments existants, la source peut créer un identifiant unique ( SE_UUID ).
Voici son fonctionnement :
- Lors du premier import d'un élément, la source va regarder si cet élément dispose d'un SE_UUID.
- Si ce n'est pas le cas, alors un SE_UUID sera généré pour cet élément
- Cet identifiant sera écrit dans le fichier de l'élément et permettra de conserver l'unicité de cet élément.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description |
|---|---|---|
| create_and_write_SEUUID_in_file | create_and_write_SEUUID_in_file | Permet de ccréer un identifiant unique ( SE_UUID ). Deux valeurs possible
|
Récupération du SE_UUID des éléments existants pour l'écrire dans le fichier
Si vous souhaitez fusionner avec un élément existant en staging et conserver ce lien même si toutes les propriétés utilisées en tant que clés de synchronisation sont modifiées, la source peut écrire le SE_UUID de l'élément existant dans le fichier cfg.
Voici son fonctionnement :
- Lors du premier import d'un élément, la source va regarder si cet élément dispose d'un SE_UUID.
- Si ce n'est pas le cas, alors une recherche d'un élément existant sera réalisée à partir des clés de synchronisation.
- Si un élément dispose des mêmes clés de synchronisation, alors la source va écrire le SE_UUID de cet élément dans le fichier cfg et l'ajouter dans la définition de l'élément.
- Une fois importé, l'élément ne sera pas en nouveau, mais pourra apporter des différences avec l'élément existant
| Info |
|---|
La recherche d'un élément existant se base uniquement
|
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description |
|---|---|---|
| update_cfg_with_staging_se_uuid | update_cfg_with_staging_se_uuid | Permet de rechercher un élément existant à partir des clés de synchronisation et recupérer son SE_UUID Deux valeurs possible
|
Précisions techniques
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 HIDDEN - V02.08.02 - la page Le mélange des sources & les clés de synchronisation (sync-key) ).
Le paramètre properties_used_as_synckey de la source permet d'ajouter les propriétés qui serviront à créer les clés de synchronisation ( Voir Module de source la page Collecteur de type cfg-file-import ( format Shinken ou nagios ) ).
Propriétés par défaut utilisé pour la construction des clés de synchronisation
| Propriété | Type d'élément | Info | ||
|---|---|---|---|---|
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation | ||
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation | ||
| hôte |