Aller au contenu

Mettre une entité en pause

La pause suspend le suivi d'une entité et de ses alarmes, sans date de fin, jusqu'à ce qu'elle soit reprise. Elle se déclenche en un clic depuis l'interface, ou par un appel d'API, un événement, un scénario ou une règle d'inactivité.

Cas typique : un pilote ouvre un ticket dans l'outil de ticketing et met l'alarme en pause. Une autre équipe traite le problème et clôture le ticket. Une intégration reprend alors l'alarme dans Canopsis.

sequenceDiagram participant C as Connecteur participant A as Canopsis participant P as Pilote participant T as Outil de ticketing participant E as Équipe externe C->>A: Crée l'alarme P-->>T: Ouvre un ticket P-->>A: Met l'alarme en pause E-->>T: Clôture le ticket T->>A: Reprend l'alarme

Pause ou comportement périodique ?

La pause remplace les comportements périodiques de type Pause sans date de fin, créés puis terminés au fil de l'eau. Les comportements périodiques restent l'outil adapté aux périodes planifiées.

Pause Comportement périodique
Usage Suspendre une entité « jusqu'à nouvel ordre », le temps qu'une équipe ou un outil externe intervienne Planifier des périodes : maintenance, heures ouvrées, fermeture, avec récurrence et exceptions
Fin Aucune date de fin : la pause dure jusqu'à la reprise Date de fin (sauf type Pause sans fin), récurrence possible
Paramètres Un commentaire et un type de pause (texte libre) Type, motif, dates, récurrence, exceptions, modèle d'entités
Cible Une ou plusieurs entités désignées Toutes les entités qui correspondent à un modèle
Prise en compte Traitée comme une action sur l'alarme (acquittement, mise en veille) Calculée à l'avance pour les prochaines heures, puis appliquée aux entités
Volume Adaptée à de nombreuses pauses créées et terminées en continu Chaque création ou modification relance le calcul des périodes : un grand nombre de créations rapprochées pèse sur les performances
Dépendances Propagation optionnelle aux ressources d'un composant et aux dépendances d'un service Selon le modèle d'entités du comportement
Historique de l'alarme Étapes « Ressource mise en pause » et « Ressource reprise » Entrée et sortie de comportement périodique

En résumé :

  • une intervention ponctuelle sans date de fin connue, pilotée par une personne ou un outil externe : utilisez la pause ;
  • une période connue à l'avance ou récurrente : utilisez un comportement périodique.

Une entité peut être à la fois en pause et sous un comportement périodique : l'un ne remplace pas l'autre. L'alarme reste inactive tant que l'un des deux s'applique.

Effets d'une pause

Lorsqu'une entité est mise en pause :

  • son alarme en cours passe en inactif, comme une alarme en veille ou sous un comportement périodique inactif ; le temps passé en pause est exclu de la durée active de l'alarme ;
  • l'étape Ressource mise en pause est ajoutée à l'historique de l'alarme, avec l'auteur, le commentaire et le type de pause ;
  • la colonne Durée de la pause du Bac à alarmes indique le temps passé en pause ;
  • dans la Météo des services, l'entité est affichée en gris avec l'icône de pause, et le compteur En pause des services est mis à jour ;
  • une nouvelle alarme créée sur l'entité pendant la pause est créée directement en pause. Un outil externe peut donc mettre une entité en pause avant l'arrivée de son premier événement, à condition que Canopsis la connaisse déjà : entité importée, ou ressource d'un composant mis en pause avec propagation aux dépendances.

Lors de la reprise, l'étape Ressource reprise est ajoutée à l'historique et l'alarme redevient active, sauf si elle est par ailleurs en veille ou sous un comportement périodique inactif.

Propagation aux dépendances

Une pause peut être propagée :

  • d'un composant à ses ressources ;
  • d'un service à toutes ses dépendances, de proche en proche.

Les dépendances reçoivent une pause héritée. Une pause héritée ne peut pas être reprise sur l'entité qui en hérite : reprenez l'entité d'origine de la pause, ce qui reprend toutes ses dépendances. Une entité ajoutée à un service en pause hérite de la pause ; une entité retirée du service est reprise.

Entité ayant plusieurs parents en pause

Une entité qui hérite d'une pause de plusieurs parents (par exemple une ressource dans deux services en pause) ne conserve que la pause la plus récente. Lorsque ce parent est repris, ou que l'entité ne lui est plus rattachée, l'entité est reprise, même si ses autres parents sont toujours en pause.

Mettre en pause depuis l'interface

Délai d'affichage

La mise en pause et la reprise peuvent prendre jusqu'à 60 secondes avant d'apparaître dans l'interface.

Bac à alarmes

L'action Mettre en pause des alarmes (et des actions de masse) met en pause l'entité de l'alarme. Lorsque l'entité est en pause, elle est remplacée par l'action Supprimer la pause, qui la reprend.

Alarmes en pause dans le Bac à alarmes : icône de pause dans les détails supplémentaires

Son fonctionnement se règle dans les paramètres du widget, section Pause :

Paramètre Description
Action Pause (recommandée) L'action met l'entité en pause
PBehavior de type Pause Ancien fonctionnement : l'action crée un comportement périodique de type Pause
Types de pause Types proposés au pilote : nom, commentaire et type. Avec plusieurs types, le pilote choisit dans un menu en cliquant sur Mettre en pause ; avec un seul type ou aucun, la pause est appliquée directement
Propager la pause à toutes les dépendances La pause est propagée aux dépendances de l'entité (voir Propagation aux dépendances)

Choix du type de pause dans le menu des actions d'une alarme

Explorateur de contexte

Les actions Mettre en pause et Réactiver s'appliquent aux entités sélectionnées. Une pause héritée ne peut pas être supprimée depuis l'entité qui en hérite.

Météo des services

Les actions Pause et Supprimer la pause sont disponibles sur les entités des services.

Masquer les alarmes en pause

Les alarmes en pause restent dans le Bac à alarmes. Pour les masquer aux pilotes, ajoutez au filtre de la vue un modèle d'entités sur le champ Pause, avec la condition « n'existe pas ». Les champs Auteur de la pause et Initiateur de la pause sont aussi disponibles dans les modèles d'entités.

Automatiser la pause

Scénarios

Les scénarios proposent :

  • les actions Mettre en pause et Reprendre ;
  • les déclencheurs Alarme mise en pause et Alarme reprise.

Règles d'inactivité

Une règle d'inactivité de type alarme peut avoir pour action Pause : l'entité des alarmes concernées est alors mise en pause.

API

La pause et la reprise se font avec l'API publique (/api/v5), avec le droit api_entity en modification :

# Mettre en pause un composant et ses ressources
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  "$CPS/api/v5/entities/pause" -d '{
    "_id": "srv-web-01",
    "comment": "Ticket INC0012345",
    "type": "Ticket",
    "inherited": true
  }'

# Reprendre
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  "$CPS/api/v5/entities/resume" -d '{"_id": "srv-web-01", "comment": "Ticket INC0012345 clôturé"}'
Champ Description
_id Identifiant de l'entité (obligatoire)
comment Commentaire, repris dans l'historique de l'alarme (255 caractères maximum)
type Type de pause, texte libre (255 caractères maximum)
inherited Pause seulement : propage la pause aux dépendances

Les routes POST /api/v5/bulk/entities/pause et POST /api/v5/bulk/entities/resume prennent un tableau de ces éléments et répondent 207 Multi-Status. La reprise d'une entité qui n'est pas en pause répond 404.

Un connecteur peut aussi envoyer directement des événements pause et resume (par l'API /api/v5/event ou par RabbitMQ), y compris avant le premier événement check d'une entité déjà connue de Canopsis. Les champs pause_type et inherited de l'événement correspondent à type et inherited.

Une entité inconnue de Canopsis (jamais vue dans un événement ni importée) ne peut pas être mise en pause : l'événement pause est ignoré, et POST /api/v5/entities/pause répond 404. Pour anticiper la pause d'une nouvelle entité, importez-la d'abord (import d'entités).

Ordre des événements

Canopsis s'appuie sur la date (timestamp) des événements : une reprise plus ancienne que la pause qu'elle termine est ignorée, et une reprise reçue avant sa pause empêche cette pause tardive de s'appliquer. Renseignez donc la date réelle de l'action dans les événements.

Droits

Droit Permet de
Bac à alarmes : Mettre en pause / reprendre les alarmes Utiliser l'action Pause dans le Bac à alarmes
Explorateur de contexte : Mettre en pause / reprendre les entités Utiliser les actions de pause dans l'Explorateur de contexte
Météo des services : Mettre les entités en pause et Reprendre les entités en pause Utiliser les actions de pause dans la Météo des services

Migrer depuis les comportements périodiques de type Pause

Si vos pilotes ou vos intégrations créent des comportements périodiques de type Pause sans date de fin, puis les terminent en ajoutant une date de fin :

  1. Dans les widgets Bac à alarmes, choisissez Action Pause dans la section Pause des paramètres, et définissez les types de pause proposés aux pilotes.
  2. Dans vos scripts et intégrations, remplacez la création du comportement périodique par POST /api/v5/entities/pause (ou un événement pause), et l'ajout de la date de fin par POST /api/v5/entities/resume (ou un événement resume).
  3. Dans les scénarios qui créaient un comportement périodique de pause, utilisez l'action Mettre en pause.
  4. Mettez à jour les filtres de vue qui excluaient les alarmes sous comportement périodique de type Pause : utilisez le champ d'entité Pause.

Les comportements périodiques de type Pause existants ne sont pas convertis : ils continuent de s'appliquer jusqu'à leur fin.