Vocabulaire des termes de Canopsis¶
Alarme¶
Une alarme est le résultat du traitement des évènements par un moteur. Elle sert à signaler un problème.
Une alarme est liée à une entité de type composant, ressource ou service. La combinaison d'un connecteur, d'un nom de connecteur, d'un composant et d'une ressource crée une alarme unique. Si l'un de ces éléments change, une alarme différente est créée.
Une alarme peut connaître de multiples changements de criticité, priorité et de statut, et subir une suite d'actions (acquittement, mise en veille, changement de criticité, annulation, etc.), utilisateurs ou automatiques. L'ensemble de ces changements et de ces actions constitue le cycle d'alarme.
Les alarmes peuvent être affichées à l'aide d'un widget Bac à alarmes.
Vous pouvez consulter la structure des alarmes présente dans le Guide de développement.
Battement¶
Un moteur effectue une tâche périodique appelée battement (ou beat) à un intervalle régulier. L'intervalle typique est de 1 minute.
Composant¶
Un composant peut être soit :
- Un type d'entité créé après le traitement d'un évènement.
- Le champ
componentd'un évènement. Le plus souvent, il s'agit d'une machine ou d'un périphérique réseau (serveur, routeur, etc.). Une alarme peut être rattachée à ce composant.
Context-Graph¶
Le context-graph est un schéma relationnel entre les entités de Canopsis. Il sert à grapher leur contexte. Il s'appuie sur les notions de impact et depends. Il est présent au sein de chaque entité et est accessible au travers du widget Explorateur de contexte.
Connecteur¶
Un connecteur peut être soit :
- Un type d'entité créé suite au traitement d'un évènement. Il est le fruit de la concaténation des champs
connectoretconnector_name. - Le champ
connectord'un évènement. Le plus souvent, il s'agit du nom du logiciel qui envoie ses données à Canopsis. Il sert à créer l'entité connecteur. - Un script ou un programme permettant d’envoyer à Canopsis des évènements à partir de sources d'informations extérieures.
Criticité¶
Une alarme a une criticité, indiquant la gravité de l'incident.
Il y a actuellement 4 criticités possibles :
- 0 - Info (quand en cours) / OK (quand résolue), de type stable.
- 1 - Mineure (minor), de type alerte.
- 2 - Majeure (major), de type alerte.
- 3 - Critique (critical), de type alerte.
Enrichissement¶
L'enrichissement est l'action d'ajouter des informations supplémentaires à une structure de données.
On peut enrichir :
- Un évènement via l'event-filter du moteur
engine-che. - Une entité via l'event-filter du moteur
engine-che, l'Explorateur de contexte ou les drivers. - Une alarme via le moteur
engine-dynamic-infos.
Entité¶
Les entités servent à structurer les alarmes. Elles sont liées entre elles via le context-graph. Elles peuvent permettre, via l'enrichissement de conserver des données statiques (emplacement du serveur, nom du client, etc.).
Les entités sont accessibles au travers du widget Explorateur de contexte.
Les entités ont les propriétés suivantes :
| Type d'entité | Résulte du traitement d'un évènement | Peut être lié à une alarme |
|---|---|---|
| composant | ✅ | ✅ |
| connecteur | ✅ | ❌ |
| service | ❌ | ✅ |
| ressource | ✅ | ✅ |
Vous pouvez consulter la structure d'une entité présente dans le Guide de développement.
Évènement¶
Un évènement est un message arrivant dans Canopsis.
Il est formaté en JSON et peut être de plusieurs types, avec leurs propres structures.
Les évènements de type check peuvent provenir d'une source externe, d'un connecteur (email, SNMP, etc.) ou de Canopsis lui-même. Ils aboutissent à la création ou la mise à jour d'une alarme dans le Bac à alarmes.
Impact¶
Une entité de service a un niveau d'impact permettant de calculer la priorité des alarmes liées à l'entité.
Ce niveau d'impact permet aussi de définir la couleurs de l'alarme ou de la tuile liée au service dans la météo de services.
Météo¶
La météo des services est un widget qui permet d'avoir une vue globale sur l'état d'un ensemble d'entités. Pour cela, elle affiche des tuiles dont la couleur est représentative de la priorité des alarmes calculée par le service lié.
Moteur¶
Un moteur Canopsis consomme les évènements entrants pour les traiter, puis les acheminer vers les moteurs suivants. Ils effectuent également une tâche périodique au battement et consomment leurs enregistrements en base de données lorsqu'ils sont disponibles.
Nom de connecteur¶
Un nom de connecteur (ou connector_name) est le champ d'un évènement. Le plus souvent, il s'agit du nom du logiciel qui envoie ses données à Canopsis, complété par sa localisation ou sa numérotation (superviseur_lille ou superviseur_5 par exemple). Il sert à créer l'entité connecteur.
Priorité¶
Une alarme a une priorité qui est le produit de la criticité d'une alarme et du niveau d'impact d'une entité liée. Cette priorité est recalculée par le service lié à chaque changement de criticité de l'alarme.
Ressource¶
Une ressource peut être soit :
- Un type d'entité créé suite au traitement d'un évènement. Il est le fruit de la concaténation des champs
resourceetcomponent. - Un champ d'un évènement. Le plus souvent, il s'agit du nom de la vérification effectuée (RAM, DISK, PING, CPU, etc.). Une alarme peut être rattachée à une ressource.
Service¶
Un service peut être soit :
- un type d'entité constituant l'arbre de dépendances, auquel peut être ajoutée une catégorie. Il s'agissait anciennement des watchers/observateurs.
- le nom de certains composants de Canopsis n'étant pas des moteurs. Par exemple,
canopsis-apiest un service et non pas un moteur, puisqu'il ne consomme pas d'évènements. - dans le cadre d'une installation de type paquets, le nom d'une unité systemd lançant un composant de Canopsis.
Statut des alarmes¶
Une alarme a un statut, indiquant la situation dans laquelle se trouve l'alarme indiquant un incident.
Il y a actuellement 5 statuts possibles :
- 0 - Fermée
- Une alarme est considérée fermée (off) si elle est stable. C'est-à-dire que sa criticité est stable à 0.
- 1 - En cours
- Une alarme est considérée en cours (ongoing) si sa criticité est dans un état d'alerte (supérieur à 0).
- 2 - Furtive
- Une alarme est considérée furtive (stealthy) si sa criticité est passée d'alerte à stable dans un délai spécifié.
- Si la criticité de cette alarme est de nouveau modifiée durant le délai spécifié, elle est toujours considérée furtive.
- Une alarme restera furtive pendant une durée spécifiée et passera à fermée si la dernière criticité était 0, en cours s'il s'agissait d'une alerte, ou bagot si elle se qualifie en tant que tel.
- 3 - Bagot
- Une alarme est considérée bagot (flapping) si elle est passée d'une criticité d'alerte à un état stable un nombre spécifique de fois sur une période donnée.
- 4 - Annulée
- Une alarme est considérée annulée (cancel) si l'utilisateur l'a signalée comme telle à partir de l'interface utilisateur.
- Après une période donnée, une alarme marquée comme annulée changera de criticité pour être considérée comme résolue.
Relations entre les statuts d'une alarme¶
Note : cliquez sur les liens suivants pour accéder aux informations relatives aux variables utilisées dans ce diagramme : StealthyInterval, Nombre d'oscillations, Durée de bagot
et CancelAutosolveDelay.