PagerDuty Procédure pour l'intégration

Découvrez comment intégrer Oracle Cloud Infrastructure Notifications à PagerDuty afin de déclencher des incidents PagerDuty.

Création d'une adresse PagerDuty

Pour effectuer cette procédure, vous devez disposer de l'un des rôles suivants dans PagerDuty : Manager, Admin, Administrateur global ou Propriétaire du compte.

  1. Accédez à PagerDuty.
  2. Dans le menu Configuration, sélectionnez Services.
  3. 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 ajouter l'intégration. Sélectionnez ensuite l'onglet Intégrations et cliquez sur le bouton +New Integration.
  4. Saisissez un nom d'intégration au format monitoring-tool-service-name.

    Si vous créez un service pour votre intégration, dans Paramètres d'incident, indiquez la stratégie d'escalade, l'urgence de notification et le comportement d'incident de votre nouveau service.

  5. Sélectionnez votre type d'adresse préféré dans le menu Type d'intégration en fonction des options suivantes :
    • Oracle Cloud Infrastructure Monitoring : si vous voulez uniquement publier des messages par alarme (à l'aide du format de message d'alarme). Pour ce type d'adresse, 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 vers le sujet contenant cet abonnement, ou si vous publiez directement un message vers le sujet à l'aide du service Notifications, 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 sur 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 à cette adresse suivent le format de message générique.

      Pour plus d'informations sur le transformateur d'événement personnalisé, reportez-vous à la documentation PagerDuty.

  6. Cliquez sur le bouton Ajouter un service ou Ajouter une intégration pour enregistrer la nouvelle intégration.
    Vous êtes redirigé vers la page Intégrations de votre service.
  7. 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 de PagerDuty clé d'intégration et d'URL d'intégration (au moment de la publication de ce document) :

    PagerDuty Clé d'intégration et URL d'intégration.
    Vous disposez désormais de la clé d'intégration nécessaire pour créer un abonnement PagerDuty dans Notifications.

Création d'un abonnement PagerDuty

Pour effectuer cette procédure, vous devez avoir accès à Notifications et disposer des droits d'accès permettant de créer des sujets et des abonnements. Reportez-vous à Sécurisation des notifications (stratégies IAM).

  1. Sur la page de liste Sujets, sélectionnez Créer un sujet. Si vous avez besoin d'aide pour trouver la page de liste, reportez-vous à la rubrique Liste des sujets.
  2. 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.

    Section Clé d'intégration de l'adresse PagerDuty.
    • Protocole : sélectionnez PagerDuty.

    • URL

      Saisissez (ou copiez-collez) la partie clé d'intégration de l'URL pour votre abonnement PagerDuty. Cette partie est l'adresse PagerDuty. (Les autres parties de l'URL sont codées en dur.)
  3. Sélectionnez Créer.

    L'abonnement PagerDuty a été créé. Il reste au statut "En attente" jusqu'à ce que la confirmation soit reçue.

  4. Confirmez le nouvel abonnement PagerDuty :
    1. Accédez à PagerDuty.
    2. Accédez à l'incident intitulé "Confirmation de l'abonnement au service Oracle Notification".
    3. Cliquez sur le lien URL de confirmation.

    Exemple d'incident de confirmation (au moment de la publication de ce document) :

    Exemple d'incident de confirmation dans PagerDuty.
    Maintenant que vous disposez d'un abonnement confirmé qui référence votre adresse PagerDuty, vous pouvez tester l'intégration en publiant directement un message sur le sujet parent.

Test d'un abonnement PagerDuty (publication directe)

Pour effectuer cette procédure, vous devez avoir accès à Notifications et disposer des droits d'accès nécessaires pour publier des messages. Reportez-vous à Sécurisation des notifications (stratégies IAM).

    1. Sur la page de liste Rubriques, recherchez la rubrique à utiliser. Si vous avez besoin d'aide pour rechercher la page de liste ou le sujet, reportez-vous à Liste des sujets.
    2. Dans le menu Actions (Menu Actions) du sujet, sélectionnez Publier le message.
    3. Dans la boîte de dialogue Publier un message, renseignez les champs suivants : entrez les éléments requis par votre type d'intégration.
      • Dans Transformateur 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 au moins l'un des éléments suivants : title (chaîne), body (chaîne) et alarmMetaData (objet BLOB JSON ou tableau).

        Exemple de 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é et contient le contenu de votre message.

      Exemple d'incident PagerDuty déclenché (au moment de la publication de ce document) :

      Exemple d'incident PagerDuty déclenché.

      Exemple du contenu d'un incident PagerDuty déclenché (au moment de la publication de ce document) :

      Exemple de contenu dans un incident PagerDuty déclenché.

      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.

      Remarque

      Pour vérifier l'URL d'adresse ou d'autres détails de l'abonnement PagerDuty, reportez-vous à Obtention des détails d'un abonnement. Pour obtenir des informations de dépannage relatives aux messages publiés, reportez-vous à Message non reçu.
  • Utilisez la commande oci ons message publish et les paramètres requis pour publier un message sur un sujet :

    oci ons message publish --body <message_text> --topic-id <topic_OCID>

    Afin d'obtenir la liste complète des paramètres et des valeurs des commandes d'interface de ligne de commande, reportez-vous à Référence de ligne de commande pour Notifications.

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

    Exemple de demande pour une adresse PagerDuty de type 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éclencher un incident dans PagerDuty à partir d'un abonnement d'alarme, d'événement, de connecteur ou d'annonce à l'aide d'un abonnement dans Notifications.

Lors de la création d'un abonnement d'alarme, de règle d'événement, de connecteur ou d'annonce, sélectionnez le sujet Notifications contenant l'abonnement PagerDuty. Pour obtenir des instructions sur la création de ces ressources, reportez-vous à la documentation suivante.

Remarque

Pour vérifier l'URL d'adresse ou d'autres détails de l'abonnement PagerDuty, reportez-vous à Obtention des détails d'un abonnement.