Présentation de l'intégration à PagerDuty

Voyez comment intégrer Oracle Cloud Infrastructure Notifications à PagerDuty afin que vous puissiez déclencher des incidents PagerDuty.

Aperçu

L'intégration à PagerDuty implique les tâches suivantes.

Créer un point d'extrémité PagerDuty

Pour terminer cette procédure, vous devez avoir l'un des rôles suivants dans PagerDuty : Gestionnaire, Administrateur, Administrateur global ou Responsable de compte de base.

Allez à PagerDuty.
Dans le menu Configuration, sélectionnez Services.
Sur la page Services :
1. Si vous créez un service pour votre intégration, sélectionnez +Add Nouveau service.
2. Si vous ajoutez votre intégration à un service existant, sélectionnez le nom du service auquel vous voulez ajouter l'intégration. Sélectionnez ensuite l'onglet Intégrations et cliquez sur le bouton +New Integration.
Entrez un nom d'intégration dans le format monitoring-tool-service-name.

Si vous créez un service pour votre intégration, dans les paramètres d'incident, spécifiez la politique d'escalade, l'urgence d'avis et le comportement de l'incident pour votre nouveau service.
Sélectionnez votre type de point d'extrémité privilégié dans le menu Type d'intégration en fonction des options suivantes :
- Oracle Cloud Infrastructure Monitoring : Si vous voulez uniquement que les messages soient publiés par alarme (à l'aide du format de message d'alarme). Pour ce type de point d'extrémité, PagerDuty répond en fonction du format de message :
  - Les messages qui utilisent les formats de message génériques sont ignorés. Par exemple, si votre règle d'événement déclenche la publication d'un message pour le sujet contenant cet abonnement, ou si vous publiez directement un message pour le sujet à l'aide du service d'avis, aucun incident PagerDuty n'est créé.
  - Les messages qui utilisent le format de message d'alarme sont traités. Par exemple, si votre alarme déclenche la publication d'un message pour le sujet, qui est au format de message d'alarme, un incident PagerDuty est créé.
- Transformateur d'événement personnalisé : Si vous voulez que des messages génèrent un incident PagerDuty, qu'ils proviennent de règles d'événement, d'alarmes, de connecteurs, d'annonces de console ou de publications directes. Les messages envoyés à ce point d'extrémité suivent le format de message générique.
  
  Pour plus d'informations sur le transformateur d'événement personnalisé, voir la documentation sur PagerDuty.
Sélectionnez le bouton Ajouter un service ou Ajouter une intégration pour enregistrer votre nouvelle intégration.
Vous êtes redirigé vers la page Intégrations de votre service.
Copiez la clé d'intégration et l'URL d'intégration de votre nouvelle intégration et conservez-la en lieu sûr pour une utilisation ultérieure.
Exemple d'une clé d'intégration PagerDuty et d'une URL d'intégration (au moment de la publication de ce document) :

Vous disposez maintenant de la clé d'intégration nécessaire pour créer un abonnement PagerDuty dans le service d'avis.

Créer un abonnement PagerDuty

Pour terminer cette procédure, vous devez avoir accès au service d'avis et disposer des autorisations nécessaires pour créer des sujets et des abonnements. Voir Sécurisation des avis (politiques IAM).

Dans la page de liste Sujets, sélectionnez Créer un sujet. Si vous avez besoin d'aide pour trouver la page de liste, voir Liste des sujets.
Dans le panneau Créer un abonnement, pour Protocole, sélectionnez PagerDuty.
Le champ URL s'affiche avec un espace vous permettant d'ajouter la clé d'intégration.
- Protocole : Sélectionnez PagerDuty.
- URL :
  Entrez (ou copiez et collez) la partie clé d'intégration de l'URL pour l'abonnement PagerDuty. Cette partie est le point d'extrémité PagerDuty. (Les autres parties de l'URL sont codées de façon permanente.)
Sélectionnez Créer.

L'abonnement PagerDuty a été créé. Il reste au statut "En attente" jusqu'à ce que la confirmation soit reçue.
Vérifiez le nouvel abonnement PagerDuty :
1. Allez à PagerDuty.
2. Accédez à l'incident intitulé " Confirmation d'abonnement au service d'avis Oracle ".
3. Sélectionnez le lien URL de confirmation.
Exemple d'incident de confirmation (au moment de la publication de ce document) :

Maintenant que vous avez un abonnement confirmé qui référence votre point d'extrémité PagerDuty, vous pouvez tester l'intégration en publiant directement un message dans son sujet parent.

Tester un abonnement PagerDuty (publication directe)

Pour terminer cette procédure, vous devez avoir accès au service d'avis et les autorisations nécessaires pour publier des messages. Voir Sécurisation des avis (politiques IAM).

1. Dans la page de liste Sujets, recherchez le sujet avec lequel vous voulez travailler. Si vous avez besoin d'aide pour trouver la page de liste ou le sujet, voir Liste des sujets.
2. Dans le menu Actions (trois points) du sujet, sélectionnez Publier le message.
3. Dans la boîte de dialogue Publier le message, fournissez des valeurs pour les champs suivants : entrez les éléments requis par votre type d'intégration.
  
  Pour Formateur d'événement personnalisé, entrez un message et un titre.
  
  Exemple de message : "Utilisation non optimale détectée. Une application ou un processus peut consommer plus d'UC que d'habitude."
  
  Exemple de titre : " Alarme non optimale "
  
  Pour Oracle Cloud Infrastructure Monitoring, entrez un message contenant un objet blob JSON avec des paires clé-valeur pour severity (chaîne, obligatoire) et un ou plusieurs des éléments suivants : title (chaîne), body (chaîne) et alarmMetaData (blob ou tableau JSON).
  
  Exemple de objet blob JSON :
  { "title": "my test alarm", "body": "my test body", "severity": "warning", "alarmMetaData": { "key1": "value1", "key2": "value2" } }
  
  La valeur severity est flexible pour les tests. Pour la production, utilisez une valeur prise en charge par PagerDuty, telle que critical, error, warning ou info.
4. Sélectionnez Publier.
  Un incident PagerDuty est déclenché contenant le contenu de votre message.
  Exemple d'incident PagerDuty déclenché (au moment de la publication de ce document) :
  Exemple de contenu d'un incident PagerDuty déclenché (au moment de la publication de ce document) :
  Vous avez confirmé que la publication directe d'un message déclenche un incident PagerDuty. Utilisez ensuite votre nouvel abonnement pour déclencher des incidents PagerDuty à partir d'alarmes, d'événements et de connecteurs.
  Note
  
  Pour vérifier l'URL du point d'extrémité ou d'autres détails de l'abonnement PagerDuty, voir Obtention des détails d'un abonnement. Pour des informations de résolution des problèmes liés aux messages publiés, voir Message non reçu.
Utilisez la commande oci ons message publish et les paramètres requis pour publier un message pour un sujet :
oci ons message publish --body <message_text> --topic-id <topic_OCID>
Pour la liste complète des paramètres et valeurs des commandes de l'interface de ligne de commande, voir Référence de ligne de commande pour les avis.

Exécutez l'opération PublishMessage pour publier un message pour un sujet.

Exemple de demande pour un point d'extrémité PagerDuty du type de transformateur d'événement personnalisé :

POST /20181201/topics/<topic_OCID>/messages
Host: <topic API endpoint>
<authorization and other headers>
{
  "title": "Non-Optimal Alarm",
  "body": "Non-optimal utilization detected. An application or process may be consuming more CPU than usual."
}

Déclencher un incident PagerDuty

Déclenchez un incident dans PagerDuty à partir d'un abonnement d'alarme, d'événement, de connecteur ou d'annonce à l'aide d'un abonnement dans le service d'avis.

Lors de la création d'un abonnement à une alarme, une règle d'événement, un connecteur ou une annonce, sélectionnez le sujet d'avis qui contient l'abonnement PagerDuty. Pour obtenir des instructions sur la création de ces ressources, consultez la documentation suivante.

Note

Pour vérifier l'URL du point d'extrémité ou d'autres détails de l'abonnement PagerDuty, voir Obtention des détails d'un abonnement.