Configurer les IO notifications d’alerte pour une application tierce
Configurez une intégration de base entre Instance Observer (IO) et des intégrations tierces pour acheminer IO les notifications d’alerte vers un système externe en plus des e-mails et des SMS.
Avant de commencer
Pourquoi et quand exécuter cette tâche
Pour les intégrations tierces, les URL Webhook peuvent expirer si un abonnement n’est pas renouvelé, ou les clés API peuvent ne pas être valides au fil du temps. Assurez-vous que vos informations d’identification d’intégration sont tenues à jour pour éviter toute remise d’alerte manquée.
Procédure
- Accédez à la Impact > Intégrité de la plateforme > Surveiller > Accéder à l’observateur d’instance.
- Connectez-vous Instance Observer et accédez à Alertes > Configurer la notification.
- Sélectionnez + Créer une intégration.
-
Remplissez les champs du formulaire.
Pour une intégration tierce, saisissez les éléments suivants :
Tableau 1. Formulaire Créer une intégration Champ Description Type d'intégration Tiers. ServiceNow est sélectionné par défaut. Nom de l'intégration Nom permettant d’identifier l’intégration. Type d'authentification Authentification de base ou clé API pour l’intégration. Pour la clé API, fournissez la clé ou le nom d’utilisateur et le mot de passe de l’intégration.
Nom d'utilisateur Nom d’utilisateur associé à l’intégration. Mot de passe Mot de passe pour l’intégration. Saisir une URL URL Webhook telle qu’elle est configurée sur votre application tierce (externe). Pour plus d'informations, voir
-
Sélectionnez Tester l’intégration pour valider votre configuration et vérifier si vous pouvez envoyer la charge utile à l’application configurée.
Si vous n’avez pas les détails d’URL corrects à portée de main, vous pouvez enregistrer l’intégration en tant que brouillon et revenir la terminer plus tard.
- Si le test réussit, vous recevez une réponse HTTP 200 est une réponse réussie . Vous pouvez maintenant procéder à la soumission de l’intégration.
- Si le test échoue, un message d’erreur s’affiche en rouge. Examinez et corrigez les détails de votre intégration, tels que l’URL Webhook, le nom d’utilisateur ou le mot de passe, puis testez à nouveau.Important :Un résultat de test réussi est requis avant de pouvoir soumettre l’intégration. Si vous tentez de soumettre sans tester, un message de validation s’affiche : Résultats d’intégration de tests réussis requis pour soumettre votre intégration ou enregistrer comme brouillon si vous n’avez pas d’URL fonctionnelle.
-
Soumettez l’intégration et enregistrez-la lorsque le test réussit.
L’intégration est créée avec un état Activé.
-
Vérifiez l’état de l’intégration.
Dans l’onglet Intégrations , vérifiez que l’état de l’intégration indique Activé.Remarque :Seules les intégrations avec un statut Activé apparaissent dans l’onglet Règles de notification pour être liées à la règle de notification. Les intégrations brouillon ne sont pas disponibles à la sélection tant qu’elles ne sont pas terminées et activées.
-
Pour configurer une règle de notification pour l’intégration tierce et envoyer des alertes aux applications tierces, sélectionnez l’onglet Règles de notification .
-
Sélectionnez
pour la règle de notification, puis sélectionnez l’option Modifier .
- Entrez un nom pour la règle dans le champ Nom de la fenêtre contextuelle Modifier la règle.
- Entrez une description pour la règle de notification.
- Sélectionnez l’option d’intégration tierce comme type de notification , puis sélectionnez une valeur dans la liste.
- Sélectionnez Enregistrer.
-
Sélectionnez
-
Vérifiez la livraison de la charge utile d’alerte dans la console d’alerte en accédant à Alertes > Console des alertes.
Pour confirmer que votre intégration fonctionne correctement après le déclenchement d’une alerte :
- Sélectionnez votre instance et obtenez un instantané dans la console d’alerte.
-
Dans la liste Générer une alerte de test , sélectionnez l’alerte que vous avez configurée.
L’alerte de test que vous avez configurée s’affiche dans la liste. Par exemple, l’alerte de délai de réponse de la base de données sur votre instance.
-
Vérifiez que la charge utile de l’alerte est bien transmise au point de terminaison d’intégration configuré, qui est une instance tierce.
La charge utile de l’alerte atteint l’instance tierce tant que l’URL Webhook accepte les appels HTTP.
-
Vérifiez si l’alerte avec la charge utile spécifiée a atteint sa destination prévue.
Si l’alerte a échoué, vous verrez que le type d’alerte est en rouge, ce qui signifie qu’elle a échoué. Lors de la sélection de l’icône d’alerte en libre-service ayant échoué, le message Intégration tierce : échec s’affiche.
-
Pour afficher, modifier ou supprimer l’URL dans la fenêtre contextuelle Modifier l’intégration, revenez à Alertes > Configurer les notifications et sélectionnez
pour l’intégration.
Vous pouvez mettre à jour les paramètres d’intégration en sélectionnant l’option Modifier . L’option Supprimer reste inactive si l’intégration est associée à au moins une règle de notification. -
Identifiez et résolvez les échecs d’intégration.
Si une intégration échoue après avoir été activée, par exemple en raison d’une URL Webhook expirée, d’une clé API non valide ou d’informations d’identification expirées, IO le système détecte l’échec et le signale à votre attention. Pour identifier et résoudre un échec d’intégration :
- Dans la console d’alerte, recherchez les alertes affichées en rouge sous la colonne Type d’alerte . Un indicateur rouge signifie que la charge utile de l’alerte n’a pas réussi à transmettre la notification.
- Sélectionnez le lien Échec pour afficher tous les détails de l’erreur. Par exemple, une erreur 404 indiquant que l’URL n’est pas valide ou que la clé API a expiré.
- Sélectionnez Mettre à jour l’intégration pour modifier l’intégration avec les informations d’identification ou l’URL Webhook correctes, la tester avec succès et la soumettre à nouveau pour restaurer l’intégration à l’état Activé .
- Vous pouvez également accéder à Alertes > Configurer la notificationet sélectionnez l’intégration avec l’état Échec dans l’onglet Intégration . Modifiez la configuration d’intégration, testez-la et, lorsqu’elle réussit, soumettez-la à nouveau pour restaurer l’intégration à l’état Activé.
L’option Supprimer reste inactive si l’intégration est associée à au moins une règle de notification.
Important :Tant que l’intégration n’est pas corrigée et réactivée, les charges utiles des alertes ne sont pas transmises au point de terminaison défaillant.- Canaux de notification d’alerte IO
-
Vous pouvez afficher les échecs d’intégration sous forme d’alertes à trois endroits :
- En tant que Type d’alerte dans Alerte > Console des alertes
- En tant que
. Sélectionnez Afficher l’historique des notifications et filtrez avec Échec de l’intégration.
- Sous forme de notification par e-mail avec le nom de l’intégration, le numéro d’erreur et le message.