Appeler l'API de Datadog avec l'intégration Webhooks

Appeler l'API de Datadog avec l'intégration Webhooks

Vous pouvez utiliser l'intégration Webhooks pour déclencher des webhooks à partir de monitors et d’événements Datadog. Vous avez ainsi la possibilité de faire communiquer votre compte Datadog avec votre équipe à l’aide d’outils de communication personnalisés, ou encore de transférer des alertes de monitor sous forme de messages texte.

Il est également possible de configurer des notifications de webhook pour appeler l'API Datadog, par exemple si vous souhaitez envoyer une métrique ou un événement à votre compte Datadog chaque fois qu’un monitor est déclenché.

Marche à suivre

Chaque webhook doit être configuré avec un nom (qui doit être spécifié dans les monitors) et une URL (qui doit être ping par le webhook). Pour envoyer un appel à l’API Datadog, sélectionnez « Use custom payload » et ajoutez votre charge utile personnalisée dans le champ correspondant.

  • Champ Name : indiquez le nom de votre choix, tant qu’il est unique parmi l’ensemble des noms de webhook.

  • Champ URL : l’URL utilisée pour ping l’API. Ressemble à : https://api.datadoghq.com/api/v1/<ENDPOINT_API>?api_key=<CLÉ_API_DATADOG>

  • Champ Custom payload : contient le JSON avec toutes les options que vous souhaitez inclure dans l’appel d’API. Les options appropriées dépendent du type d’appel. Il est parfois possible d’utiliser le contenu $symbol du monitor pour remplir une partie des valeurs des options.

Exemple

Imaginez qu’un membre de votre équipe souhaite connaître le nombre de monitors dont le statut est OK et le nombre de monitors dont le statut est CRITICAL parmi une série de monitors exécutés. Vous pouvez configurer une notification de webhook de façon à envoyer un appel d’API « check_run » chaque fois que le statut de l’un de ces monitors passe à OK ou CRITICAL. Ensuite, vous pouvez ajouter un widget « Check status » dans un screenboard pour permettre à votre coéquipier de visualiser le statut de l’ensemble de ces monitors à tout moment.

Dans ce cas, vous avez besoin de deux webhooks distincts, un pour « mongroupedemonitors-alert-check » et un autre pour « mongroupedemonitors-ok-check ». Les deux utilisent le même endpoint d’API. Leur nom et leur URL doivent respecter les formats suivants :

  • Name : mongroupedemonitors-alert-check URL : https://api.datadoghq.com/api/v1/check_run?api_key=<CLÉ_API_DATADOG>

  • Name : mongroupedemonitors-ok-check URL : https://api.datadoghq.com/api/v1/check_run?api_key=<CLÉ_API_DATADOG>

La charge utile personnalisée est l’endroit où le nom et les tags du check_run sont appliqués. Pour le webhook « alert », consultez l’exemple suivant :

{
  "check": "mymonitorgroup.status",
  "status": 2,
  "host_name": "$HOSTNAME",
  "tags": "[monitor:$ALERT_TITLE]"
}

Avec cette charge utile personnalisée, chaque fois que @webhook-mongroupedemonitors-alert-check est déclenché par un monitor, un check_run appelé « mongroupedemonitors.status » est envoyé avec le statut CRITICAL. Celui-ci est tagué avec le nom du monitor et, le cas échéant, le nom du host sur lequel le monitor est déclenché.

Vous pouvez alors appliquer la même charge utile personnalisée pour le check « mongroupedemonitors-ok-check », mais en définissant le « status » sur « 0 » au lieu de « 2 » pour spécifier le statut « OK ».

Une fois ces deux webhooks définis, accédez à vos monitors (ceux que votre coéquipier souhaite visualiser rapidement) et ajoutez les références de la notification de webhook en les entourant du tag de logique conditionnelle approprié, comme suit :

{{#is_alert}} @webhook-mongroupedemonitors-alert-check {{/is_alert}}
{{#is_recovery}} @webhook-mongroupedemonitors-ok-check {{/is_recovery}}

Une fois vos monitors configurés et prêts à envoyer des alertes (ils doivent avoir envoyé au moins une alerte avec un statut OK ou CRITICAL pour être inclus dans le nombre total de statuts), vous pouvez alors configurer un widget « Check status » dans un screenboard pour votre « mongroupedemonitors.check ». Ici, le regroupement se fait en fonction du tag « monitor ».

Voici un exemple de tel widget (même si dans cet exemple, le nom du check est « composite.status » et un seul monitor dans notre groupe s’est déclenché avec le statut « alert » puis « OK ») :