Utilité des sources
Les sources permettent de récupérer des informations via des ressources externes et de transformer ces informations en éléments shinken. Elles sont personnalisables et programmables enfin de pouvoir automatiser l'import de nouveaux éléments de différentes façons. Il existe trois types de sources dans shinken :
- Les analyseurs permettent de récupérer des informations d'un hôte en exécutant des scripts d'analyses sur ceux-ci.
- Les écouteurs permettent de créer des hôtes avec des requêtes HTTP via une API.
- Les collecteurs récupèrent et créent des éléments de différentes façons (vmware, ldap, par découverte réseaux ou bien par fichier cfg).
Fonctionnement des sources
Explication de l'import
Merges des sources
Lorsqu'un import est effectué par une source, les données chargées par celle-ci vont générées des éléments dans Shinken (hôtes, check, cluster, etc...). Quand un élément est créé, le synchronizer cherche à vérifier parmi tous les éléments des dernières importations de chaque source active, deux éléments qui ont une clé de synchronisation commune.
Si c'est le cas, il va fusionner tous les éléments qui ont la même clé de synchronisations pour n'en former qu'un seul. Si plusieurs éléments avec la même clé de synchronisation ont des champs en commun, l'élément final prendra la valeur de l'élément venant de la source avec l'ordre le plus proche de 1. Dans le cas où un champ est présent sur un seul élément mais pas sur les autres, le champ apparaîtra sur l'élément final quel que soit l'ordre de la source dont il provient (cf: voir l'exemple ci-dessous)
Lorsque des sources importent des éléments, ceux-ci sont fusionnés s'ils possèdent au moins une clé de synchronisation commune.
Les clés de synchronisation utilisées dépendent du type de l'élément:
- Hôtes: Nom, adresse, SE_UUID (Identifiant unique pouvant être défini dans les fichiers de configuration)
- Checks: SE_UUID
- Autres: Nom de l'élément, SE_UUID
Exemple: Deux hôtes avec la même adresse seront regroupés par le mécanisme d'import des sources en un seul hôte :
| Code Block |
|---|
define host {
host_name Hote 1
address localhost
propriété_commune valeur1
propriété1 valeur1
}
define host {
host_name Hote 2
address localhost
propriété_commune valeur2
propriété2 valeur2
} |
Résultat de la fusion des 2 hôtes, le premier hôte vient de la source avec l'ordre le plus bas:
| Code Block |
|---|
define host {
host_name Hote 1
address localhost
propriété_commune valeur1
propriété1 valeur1
propriété2 valeur2
} |
Le résultat est comparé à la base de Staging. Si l'élément existe en Staging, celui-ci apparaîtra en statut "Différence", dans le cas contraire il apparaîtra en "Nouveau". Les éléments avec le statut Nouveau seront prêts à être importés dans Staging ou dans la "Zone de travail" pour les hôtes.
Mise à jour de Staging
Les éléments avec le statut "Nouveau" et "Différence" sont affichés dans les "Liste des éléments". Il est possible de les filtrer pour n'afficher que ces objets.
Dans la page principale, les compteurs sont des raccourcis pour afficher ces listes déjà filtrées.
| Panel |
|---|
|
Les éléments avec le statut "Nouveau" sont affichés tels qu'ils vont être importés dans Staging, dans la liste des éléments et dans la page d'édition d'un élément.
Les éléments avec le statut "Différence" sont affichés tels qu'ils sont dans Staging, mais avec la liste des valeurs qui seront modifiés par application des différences. Ces modifications apparaissent au survol du label vert de Différence dans la liste des éléments, ou dans l'onglet de différence des objets dans la page d'édition d'un éléments.
| Panel |
|---|
|
Importer les nouveaux éléments
Il y a deux manières différentes pour import un nouvel élément.
Si vous souhaitez appliquer les différences un ou plusieurs éléments en Staging ou Zone de travail, il faut :
- Aller dans la liste du type de l'élément ou bien dans la liste de "Tous les éléments"
- Puis sélectionner les éléments avec le statut "Nouveau"
- Enfin sélectionner l'Action de masse adéquat adéquate, c'est-à-dire "Importer d'une source
Dans le cas où vous souhaitez importer sur un élément en particulier, vous pouvez:
- Aller dans la page d'édition de l'élément
- Vérifier toutes les propriétés
- Import l'élément en cliquant sur le bouton (todo mettre le screen du bouton )
(todo faire screen d'un import depuis une liste)
Appliquer les différences
Il y a deux manières différentes pour Comme pour l'import, appliquer les différences sur un élémentpeut se faire deux manières différentes.
Si vous souhaitez appliquer les différences un ou plusieurs éléments en Staging, il faut :
- Aller dans la liste du type de l'élément ou bien dans la liste de "Tous les éléments"
- Puis sélectionner les éléments avec le statut "Différence"
- Enfin sélectionner l'Action de masse adéquat adéquate, c c'est-à-dire "Appliquer les différences des sources".
Dans le cas où vous souhaitez appliquer les différences sur un élément en particulier, vous pouvez:
- Aller dans la page d'édition de l'élément
- Vérifier les propriétés modifiés modifiées dans l'onglet "Différences"
- Appliquer les différences en cliquant sur le bouton (todo mettre le screen du bouton )
| Panel |
|---|
|
| Info |
|---|
Rappel: la modification d'un hôte ne peut se faire que dans la "Zone de travail", ce qui veut dire que l'import et l'application des différences doivent se faire dans cette partie. |
Comment faire un import
Pour obtenir des éléments d'une source configurée, fonctionnelle et activée, un import peut être nécessaire.
Il existe 2 moyens pour cela :
- Un import peut s'effectuer à intervalles réguliers. Cet intervalle est défini dans le fichier de configuration de votre source.
Vous pouvez savoir quand le prochain import aura lieu en allant dans la zone des modules de détection et qualification, en face de votre source sous la colonne "Prochain import" vous pouvez voir le temps restant avant le prochain import.
| Panel |
|---|
|
- Vous pouvez forcer un import si l'import à intervalles réguliers n'est pas activé ou si vous voulez faire un import sans devoir attendre le prochain.
Pour cela aller dans la zone des modules de détection et cliquez sur la flèche en face de votre source, sous la colonne "Forcer l'import". La source doit être activée.
Un
| Panel |
|---|
|
L'autre moyen pour forcer l'import est:
- De est de vous rendre sur la page de votre source en cliquant sur son le nom de la source
- Puis dans la zone des modules de détections et qualification, puis cliquez sur la flèche en haut à droite de la page.
| Panel |
|---|
|
| Panel |
|
État de la source et résumé du dernier import
États des sources
Chaque source activée possède un état qui peut être vu à trois endroits :
- Dans Sur la page principale, dans la colonne "État" de chaque source
- Sur la page de la source à droite du nom
- Sur la page de la source, dans Dans l'onglet des résumés des dernières exécutions d'une sourceDans la page de la source à coté du nom
Cet état correspond à celui du dernier import. Il est mis à jour pendant l'import (import Import en cours, calcul Calcul des différences), après l'import (okOk, avertissement, erreur, non configuréAvertissement, Erreur) ou dynamiquement (non Non configuré, prêt Prêt à être importé).
Voici la liste complète des statuts d'une source et leur signification :
| Statut | Description |
|---|---|
| Les éléments ont été importés, la source fonctionne correctement |
| Les éléments ont été partiellement importés à cause d'une erreur mais la source fonctionne |
| Les éléments n'ont pas été importés, la source ne fonctionne pas |
| La source ne possède pas de configuration |
| La source vient d'être créée, elle n'a jamais importé d'éléments | |
| Des paramètres de la sources ont été changé, un import peut être utile pour recevoir de nouveaux éléments |
| Import des éléments en cours |
| Calculs en cours pour la fusion des sources juste après l'import |
| l' |
| import |
Résumé du dernier import
A chaque fois qu'un import est effectué, un message contenant le résultat de cet import est disponible. Il permet d'obtenir plus d'information sur le statut de la source.
Un résumé court est disponible :
- Dans la page principale dans la colonne "Résumé" de chaque source
- Dans la page de la source à coté du nom
- Dans le Résumé des dernières exécutions
Un résumé plus long et détaillé est disponible dans l'onglet des Résumé des dernières exécutions.
Lorsqu’un import est effectué (Collecteur) ou bien qu’une exécution est lancée (Écouteurs et Analyseurs), son rapport est stocké dans le résumé des dernières exécutions vous permettant d’avoir un récapitulatif détaillé.
Cet onglet est disponible de deux manières :
- Depuis la page de la source en cliquant sur l’onglet concerné
- Depuis la page principale en cliquant sur le lien à côté du résultat
| Panel |
|---|
|
| Panel |
|---|
|
Lorsque vous arrivez sur l’onglet, vous serez directement redirigé vers la dernière exécution. Pour voir le résumé d’une autre exécution, il suffit de cliquer sur la ligne correspondant à sa date (1)
Votre résumé sera composé d’un maximum de 6 sections, les erreurs et avertissement sont présent qu'en cas de problème :
- Le résultat (2)
- Les erreurs liées à la source (3)
- Les erreurs liées au mélange des sources (3)
- Les avertissements liés à la source (3)
- Les avertissements liés aux mélanges des sources (3)
- Les éléments ajoutés/modifiés suite à l’import/exécution (4)
Éléments du dernier import
Après un import, les éléments importés peuvent être en état:
- "ok"
- "attention"
- "erreur"
Les éléments en état "attention" sont bien importés mais incomplet (champs manquant ou dans un mauvais format par exemple), ils risquent de ne pas pouvoir être importés en production. Les éléments en "erreurs" ne se sont tout simplement pas importés car ils contiennent une erreur rendant impossible leur import. Sur la page principale, en face de votre source sous la colonne "Éléments" on peut voir les statuts des éléments du dernier import selon leur couleur. Par exemple un 7 vert et un 2 rouge signifie que 7 élément se sont bien importé en état "ok" mais 2 éléments en état "erreur" n'ont pas pu être importés.
Cliquer sur une des trois couleurs permet de se rendre directement dans la page de la source qui a effectué l'import, dans l'onglet "Détails du dernier lancement" et d'appliquer un filtre selon la couleur choisis.
| Panel |
|---|
|
Le filtre est directement appliqué quand on est redirigé vers la page quand on clique sur une couleur (1). Pour avoir plus d'informations sur un élément importé, cliquez sur l'œil (2) à droite de votre élément pour déplier ses informations supplémentaires. Vous pouvez voir en bas (3) une explication de l'avertissement ou de l'erreur si l'élément n'est pas en statut "ok".
| Panel |
|---|
|
Utilisation des sources
Exemple d'utilisation avec la discovery
On va suivre dans cet exemple comment utiliser la source discovery pour importer des éléments grâce à une adresse ip.
Pour commencer, il faut activer la source (discovery dans notre exemple) pour qu'elle puis fonctionner et importer des éléments un fois qu'elle sera configuré.
| Panel |
|---|
|
Pour configurer la source, il faut se rendre sur la page de la discovery. Pour ça, il suffit de cliquer sur son nom.
| Panel |
|---|
|
Pour pouvoir trouver des éléments grâce à cette source, il faut ajouter des plages ip qui vont être scanner par la suite. Il faut donc se rendre dans l'onglet "Listes de plages réseaux définies".
| Panel |
|---|
|
Une fois rendu dans cette onglet, il faut ajouter notre plage ip en cliquant sur le bouton ajouter en haut à droite de la page.
| Panel |
|---|
|
Il faut maintenant rentrer les informations nécessaire enfin de trouver les éléments voulus. On va chercher dans cet exemple la machine qui se trouve sur l'adresse ip 172.16.0.7 .
| Panel |
|---|
|
On a maintenant le choix d'attendre le prochain import si il a était défini dans le fichier de configuration de la source discovery ou de lancer un import directement en appuyant sur la flèche en haut de l'écran.
| Panel |
|---|
|
Le résumé du résultat de cet import est disponible dans l'onglet "Résumé des dernières exécutions". Le dernier import effectué est directement visible en arrivant dans la page. On peut voir qu'il c'est bien effectué et qu'un hôte à bien été importé.
En cliquant sur un type dans le tableaux "Résultat d'exécution", on va être redirigé dans l'onglet "Détails du dernier lancement".
| Panel |
|---|
|
L'onglet "Détails du dernier lancement" permet d'avoir plus de détails sur les éléments importés. On a cliqué sur "hosts" lors de l'étape précédente ce qui a appliqué un filtre qui permet de nous montrer que les hôtes lors du dernier import.
On peut aussi accéder à cet onglet en cliquant sur celui-ci, aucun filtre ne sera donc appliqué.
Cliquer sur l’œil à droite de chaque éléments importés permet de donner plus de détails à leur sujet.
| Panel |
|---|
|
