Aller au contenu

Automatisation avec n8n

Description

n8n est un outil d'automatisation de workflows. Le node communautaire n8n-nodes-canopsis permet de piloter Canopsis depuis un workflow n8n, et de déclencher un workflow à partir des événements d'alarme de Canopsis.

Il fournit deux nodes :

  • Canopsis : actions sur les alarmes, les entités, les événements et les comportements périodiques ;
  • Canopsis Trigger : déclenche un workflow à chaque événement d'alarme choisi, en créant automatiquement le scénario webhook nécessaire dans Canopsis (édition Pro).

Le code source du node est disponible sur le dépôt canopsis-extras/n8n-nodes-canopsis, et le paquet est publié sur npm.

Compatibilité

Version du node Version de Canopsis
1.0.x 26.04
1.1.x 26.04 et 26.10, selon le champ Canopsis Version du credential

Avec Canopsis 26.10, utilisez le node 1.1 ou une version plus récente.

Prérequis

  • Une instance n8n auto-hébergée, qui autorise l'installation de nodes communautaires.
  • Un compte utilisateur Canopsis dont le rôle donne accès à l'API et aux actions utilisées dans les workflows (alarmes, événements, comportements périodiques, scénarios).
  • La clé d'authentification (authkey) de ce compte, visible dans le profil de l'utilisateur.
  • Pour le node Canopsis Trigger : l'édition Pro de Canopsis, et une instance n8n joignable par Canopsis, qui doit pouvoir appeler l'URL du webhook n8n.

Installation

Dans n8n, ouvrez Settings > Community nodes, cliquez sur Install, puis saisissez le nom du paquet :

n8n-nodes-canopsis

Les nodes Canopsis et Canopsis Trigger apparaissent alors dans la liste des nodes de l'éditeur de workflows.

Connexion à Canopsis

Créez un credential de type Canopsis API :

Champ Description
Base URL Adresse de Canopsis, sans chemin d'API, par exemple https://canopsis.example.com.
Canopsis Version Version de Canopsis, qui détermine les routes appelées : 26.04 utilise les routes /api/v4 (valeur par défaut, et celle des credentials créés avant la version 1.1 du node) ; 26.10 or Later utilise les routes de l'API interne /internal.
Auth Type API Key (recommandé) : l'authkey est transmise dans l'en-tête x-canopsis-authkey. Basic Auth : identifiant et mot de passe.
Ignore SSL Issues À cocher seulement pour une instance dont le certificat est auto-signé.

Adresse et version de Canopsis

Renseignez dans Base URL l'adresse servie par le reverse proxy Nginx de Canopsis, et non l'adresse directe d'un service d'API (port 8082), puis choisissez 26.10 or Later dans Canopsis Version. Un credential laissé sur 26.04 continue de fonctionner tant que Nginx redirige les routes /api/v4 vers l'API interne, mais cette redirection est temporaire. Le guide de migration vers Canopsis 26.10.0 détaille la séparation de l'API publique et de l'API interne.

Node Canopsis

Ressource Opérations
Alarm Get Many (liste paginée, avec recherche), Acknowledge, Ack Remove, Add Comment, Snooze, Associate Ticket, Remove Ticket, Cancel, Uncancel, Change State
Entity Get Many (liste paginée, avec recherche)
Event Send : envoie un événement check (connector, connector name, source type, component, state, et en option resource, output, long output, timestamp et champs libres)
Pbehavior Create, Get Many, Update, Delete

Les actions sur une alarme attendent son identifiant (_id), tel que retourné par l'opération Get Many. Dans un workflow, il se reprend d'un node précédent avec l'expression {{ $json._id }}.

Node Canopsis Trigger

Info

Ce node nécessite l'édition Pro de Canopsis.

Le node Canopsis Trigger démarre un workflow lorsqu'un événement se produit sur une alarme. Il gère lui-même le scénario correspondant dans Canopsis :

  • à l'activation du workflow, il crée un scénario de type webhook qui appelle l'URL du webhook n8n ;
  • à la désactivation, il supprime ce scénario ;
  • à la réactivation, il réutilise le scénario s'il existe déjà. Son identifiant, n8n-wf-<identifiant du workflow>, évite les doublons.
Paramètre Description
Trigger Events Déclencheurs du scénario, par exemple create, resolve, stateinc, statedec, ack, comment, assocticket, snooze, pbhenter ou pbhleave. Voir la liste des déclencheurs.
Go Payload Template Corps du webhook envoyé par Canopsis, écrit avec les modèles Go. {{ . \| json_unquote }} transmet tout le contexte.
HTTP Headers En-têtes du webhook ; Content-Type: application/json est prérempli.
Options Priorité du scénario, pattern d'alarmes, pattern d'entités, et désactivation de la vérification TLS du webhook n8n.

Exemple de payload :

{
  "alarm_id": "{{ .Alarm.ID }}",
  "component": "{{ .Alarm.Value.Component }}",
  "resource": "{{ .Alarm.Value.Resource }}",
  "state": "{{ .Alarm.Value.State.Value }}"
}

Exemple de workflow

Un workflow simple pour démarrer :

  1. Un node Canopsis Trigger sur le déclencheur create, limité par un pattern d'alarmes aux alarmes critiques.
  2. Un node de messagerie (Slack, Microsoft Teams, e-mail...) qui prévient l'équipe d'astreinte.
  3. Un node Canopsis (Alarm > Add Comment) qui trace la notification dans l'historique de l'alarme.