Déclencher un workflow

Vous pouvez déclencher un workflow manuellement ou automatiquement, et un workflow peut avoir plusieurs déclencheurs. Cela vous permet de déclencher un workflow à partir de diverses sources, comme un monitor Datadog et un dashboard Datadog.

Un workflow s’exécute avec l’identité de son propriétaire, de l’utilisateur qui a déclenché l’exécution ou d’un compte de service associé. Les déclencheurs qui s’activent sans utilisateur, tels que les plannings et les webhooks, nécessitent le propriétaire ou un compte de service. Pour plus d’informations, consultez Workflow identity.

Un workflow avec plusieurs déclencheurs

Déclencheurs manuels

Pour déclencher un workflow manuellement :

  1. Depuis la page du workflow, cliquez sur Run.
  2. Saisissez les valeurs des variables de déclenchement existantes.
  3. Lorsque vous êtes prêt à exécuter le workflow, cliquez sur Save & Run.

Déclencheurs de dashboard

Pour déclencher un workflow depuis un dashboard, ajoutez le widget Run Workflow :

  1. Depuis votre dashboard, cliquez sur Add Widget.
  2. Recherchez workflows et ajoutez le widget Run Workflow.
  3. Sous Select the workflow, recherchez votre workflow dans le menu déroulant. Seuls les workflows publiés avec des déclencheurs de dashboard apparaissent dans la liste.
  4. Associez les variables de modèle de dashboard aux paramètres d’entrée du workflow. Cela permet aux valeurs de vos variables de modèle de dashboard d’être mappées directement aux paramètres d’entrée lorsque vous exécutez le workflow.
  5. Saisissez un titre pour le widget et cliquez sur Save.

Pour exécuter le workflow, procédez comme suit :

  1. Cliquez sur Run Workflow sur votre widget de dashboard.
  2. Sous Execution parameters, toutes les variables de modèle que vous avez mappées aux entrées du workflow sont automatiquement renseignées. Saisissez les valeurs des paramètres d’exécution non mappés ou modifiez les valeurs existantes si nécessaire.
  3. Cliquez sur Run pour exécuter le workflow.

Déclencheurs de monitor

Ajoutez un déclencheur de monitor à votre workflow

  1. Ajoutez un déclencheur de monitor à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Monitor.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le monitor en tant que déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Monitor.
  2. Assurez-vous que le déclencheur est connecté à une étape du workflow. Vous pouvez connecter le déclencheur à une étape en cliquant sur l’icône plus (+) sous le déclencheur et en la faisant glisser.
  3. Cliquez sur le déclencheur et prenez note de Mention handle.
  4. Les déclencheurs de monitor sont configurés pour se déclencher automatiquement par défaut. Si vous ne souhaitez pas que le workflow se déclenche automatiquement, activez ou désactivez l’option Automatic triggering.
  5. Enregistrez votre workflow.
  6. Cliquez sur Publish pour publier votre workflow. Les workflows ne s’exécutent pas automatiquement tant que vous ne les avez pas publiés. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Ajoutez le workflow à votre monitor

  1. Accédez à la Monitors page dans Datadog.
  2. Recherchez le monitor que vous souhaitez utiliser pour déclencher le workflow et modifiez-le, ou créez un nouveau monitor.
  3. Dans la section Configure notifications & automations, cliquez sur + Add Workflow.
  4. Utilisez le nom de mention du workflow pour rechercher votre workflow et sélectionnez-le dans la liste déroulante. Seuls les workflows avec des déclencheurs de monitor apparaissent dans la liste.
    Une mention pour le monitor apparaît dans le champ du message de notification, au format @workflow-name s’il ne prend aucun paramètre d’entrée ou @workflow-name(param="") s’il prend des paramètres d’entrée.
  5. Si le workflow prend des paramètres d’entrée :
    1. Cliquez sur Configure Inputs à côté du nom et de l’ID du monitor.
      Un workflow joint avec un lien Configurer les entrées disponible
    2. Enter values for the input parameters.
      Note: Values can include monitor message template variables. To see a list of available variables, click Use Message Template Variables in the upper-right of the Configure notifications & automations section.
      The parameters populate in the mention within the notification message field.
      For example, if you configure a workflow named @workflow-test-inputs to have the following parameters:
      Panneau Configurer les entrées avec des valeurs définies comme suit : im_a_string sur 'abc', im_a_number sur 123, im_a_boolean activé sur true, et i_have_a_default_value sur 'override this'
      the mention changes to @workflow-test-inputs(im_a_string="abc", im_a_number=123, im_a_boolean=true, i_have_a_default_value="override this").
  6. Enregistrez le monitor.

Chaque fois que le seuil du monitor est atteint, le monitor déclenche une exécution de workflow.

Tester un déclencheur de monitor

Consultez la page de test et de débogage pour plus d’informations sur comment tester un déclencheur de monitor.

Déclencheurs d’incident

Les déclencheurs d’incident peuvent exécuter un workflow automatiquement en fonction des événements d’incident, ou manuellement depuis un incident.

Pour configurer des automatisations d'incident dans Incident Management, avec un contexte d'incident intégré et sans facturation supplémentaire, consultez Automatisations d'incident. Utilisez un workflow avec un déclencheur d'incident lorsque les événements d'incident constituent un déclencheur parmi d'autres, ou lorsque le workflow est géré en dehors d'Incident Management.

Pour ajouter un déclencheur d’incident à votre workflow :

  1. Depuis la page de création de workflow, faites défiler jusqu’aux options de déclenchement et cliquez sur Incident.
  2. Sélectionnez le type d’événement d’incident qui doit déclencher votre workflow, par exemple lorsqu’un incident est déclaré ou mis à jour, ou selon un planning récurrent. Pour un déclencheur manuel, Workflows crée un identifiant que vous pouvez utiliser dans les monitors ou les règles de notification d’incident.
  3. Cliquez sur Create.
  4. Cliquez sur Publish pour publier votre workflow. Les workflows ne s’exécutent pas tant que vous ne les avez pas publiés. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Déclencheurs de sécurité

Vous pouvez déclencher un workflow automatiquement pour tout signal de sécurité ou toute découverte de sécurité. Vous pouvez également déclencher un workflow manuellement depuis un panneau de signal de sécurité Cloud SIEM, un panneau de mauvaise configuration ou un panneau de risque d’identité.

Remarque : Avant d’ajouter un workflow à un signal ou une découverte de sécurité, le workflow doit disposer d’un déclencheur de sécurité.

Déclencheurs de règle de notification de sécurité

Vous pouvez configurer un workflow pour qu’il se déclenche chaque fois qu’une règle de notification de sécurité envoie une notification pour un signal de sécurité ou une découverte de sécurité.

Pour déclencher un workflow à partir d’une règle de notification, vous devez d’abord ajouter un déclencheur de sécurité à votre workflow :

  1. Ajoutez un déclencheur de sécurité à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Security.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur de sécurité en tant que déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Security.
  2. Assurez-vous que le déclencheur est connecté à une étape du workflow. Vous pouvez connecter le déclencheur à une étape en cliquant sur l’icône plus (+) sous le déclencheur et en la faisant glisser.
  3. Cliquez sur le déclencheur et prenez note de Mention handle.
  4. Les déclencheurs de sécurité sont configurés pour se déclencher automatiquement par défaut. Si vous ne souhaitez pas que le workflow se déclenche automatiquement, activez ou désactivez l’option Automatic triggering.
  5. Enregistrez votre workflow.
  6. Cliquez sur Publish pour publier votre workflow. Les workflows ne s’exécutent pas automatiquement tant que vous ne les avez pas publiés. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Ajoutez le workflow à votre règle de notification :

  1. Depuis la page Configuration, recherchez la règle de notification que vous souhaitez utiliser pour déclencher votre workflow, ou créez une nouvelle règle.
  2. Dans la section Recipient, utilisez le nom de mention du workflow pour trouver votre workflow. Par exemple, @workflow-my-workflow.
  3. Sélectionnez le workflow dans la liste déroulante. Seuls les workflows avec des déclencheurs de sécurité apparaissent dans la liste.
  4. Cliquez sur Save.
Ajoutez le nom du workflow à la section des destinataires d'une règle de notification

Chaque fois que la règle de notification se déclenche, elle lance une exécution de workflow.

Déclencheurs manuels

Vous pouvez démarrer manuellement un workflow à partir d’un panneau de signal de sécurité Cloud SIEM, d’un panneau de mauvaise configuration ou d’un panneau de risque d’identité :

  1. Cliquez sur Run Workflow dans la zone Next Steps en haut du panneau latéral.
  2. Dans la fenêtre modale de recherche, saisissez le nom du workflow que vous souhaitez exécuter et sélectionnez-le. Seuls les workflows avec des déclencheurs de sécurité apparaissent dans la liste.
  3. Si votre workflow nécessite des paramètres d’entrée, saisissez les valeurs requises. Vous pouvez copier les valeurs du JSON de l’objet affiché à côté des paramètres d’entrée et les coller dans les champs de paramètres.
  4. Cliquez sur Run.

Vous pouvez voir le statut d’exécution du workflow dans la section Workflows du panneau latéral.

Pour d’autres exemples de workflows de sécurité que vous pouvez automatiser, consultez Automatiser les workflows de sécurité avec Workflow Automation.

Déclencheurs de catalogue

Pour exécuter un workflow à partir d’une entité de catalogue logiciel, vous devez d’abord ajouter un déclencheur de catalogue logiciel à votre workflow :

  1. Ajoutez un déclencheur de catalogue logiciel à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Catalog.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le catalogue logiciel comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Catalog.
  2. Assurez-vous que le déclencheur est connecté à une étape du workflow. Vous pouvez connecter le déclencheur à une étape en cliquant sur l’icône plus (+) sous le déclencheur et en la faisant glisser.
  3. Enregistrez votre workflow.
  4. Cliquez sur Publish pour publier votre workflow. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Exécutez le workflow depuis votre entité de catalogue :

  1. Sur la page Catalogue, choisissez une entité dans la liste.
  2. Cliquez sur Run Workflow en haut du panneau latéral.
  3. Dans la fenêtre modale de recherche, saisissez le nom du workflow que vous souhaitez exécuter et sélectionnez-le. Seuls les workflows avec des déclencheurs de catalogue apparaissent dans la liste.
  4. Si votre workflow nécessite des paramètres d’entrée, saisissez les valeurs requises.
  5. Cliquez sur Run pour exécuter le workflow.

Déclencheurs GitHub

Votre compte GitHub doit disposer de l'autorisation de créer des webhooks pour utiliser cette fonctionnalité.

Vous pouvez déclencher un workflow depuis GitHub en suivant les étapes suivantes.

  1. Ajoutez un déclencheur GitHub à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > GitHub.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez GitHub comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez GitHub.
  2. Accédez au dépôt GitHub que vous souhaitez utiliser pour déclencher votre workflow.
  3. Dans GitHub, cliquez sur Settings, cliquez sur Webhooks, puis cliquez sur Add webhook.
  4. Dans l’onglet Configure de votre workflow, copiez le Payload URL. Collez-le dans le champ Payload URL sur la page de création de webhook GitHub.
  5. Dans GitHub, définissez le Content type de votre webhook sur application/json.
  6. Dans GitHub, créez un secret d’au moins 16 caractères, puis copiez ce secret dans le champ Secret de votre déclencheur de workflow.
  7. Dans GitHub, choisissez les événements qui doivent déclencher votre webhook, puis cliquez sur Add webhook.
  8. Optionnellement, dans votre workflow, cliquez sur + pour ajouter un Rate Limit.
  9. Cliquez sur Save dans votre workflow.
  10. Cliquez sur Publish pour publier le workflow. Un workflow doit être publié avant que vous puissiez le déclencher depuis GitHub. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Déclencheurs Slack

Vous devez installer l'application Datadog dans votre espace de travail Slack pour utiliser cette fonctionnalité. Pour plus d'informations, consultez Configuration de Slack.
Démarrage rapide : Cliquez pour créer un workflow avec un déclencheur Slack.

Vous pouvez déclencher un workflow depuis Slack manuellement avec la commande /datadog workflow, ou automatiquement lorsqu’une réaction emoji est ajoutée à un message ou lorsqu’un message est publié dans un canal.

Déclencheur Slack manuel

  1. Ajoutez un déclencheur Slack à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Slack.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur Slack comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Slack.
  2. Assurez-vous que le déclencheur est connecté à une étape du workflow. Vous pouvez connecter le déclencheur à une étape en cliquant sur l’icône plus (+) sous le déclencheur et en la faisant glisser.
  3. Cliquez sur Save dans votre workflow.
  4. Cliquez sur Publish pour publier le workflow. Un workflow doit être publié avant que vous puissiez le déclencher depuis Slack. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.
  5. Dans un canal Slack avec l’application Datadog, exécutez /datadog workflow pour sélectionner et exécuter un workflow. Vous pouvez également utiliser l’alias /dd pour exécuter les commandes /datadog.

Déclencheur Slack par réaction emoji

Vous pouvez configurer un workflow pour qu’il se déclenche automatiquement lorsqu’un utilisateur ajoute une réaction emoji spécifique à un message dans Slack.

  1. Ajoutez un déclencheur Slack à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Slack.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur Slack comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Slack.
  2. Dans l’onglet Configure, sélectionnez l’espace de travail Slack où vous souhaitez écouter les réactions.
  3. Si l’espace de travail nécessite l’autorisation emoji:read, cliquez sur Enable Permission pour réinstaller l’application Slack avec le périmètre nécessaire.
  4. Sélectionnez une ou plusieurs réactions emoji qui déclenchent le workflow.
  5. Cliquez sur Save, puis sur Publish.

Déclencheur de message Slack

Vous pouvez configurer un workflow pour qu’il se déclenche automatiquement lorsqu’un message correspondant à vos règles est publié dans un ou plusieurs canaux Slack.

L'application Datadog Slack doit être membre de chaque canal que vous sélectionnez. Les messages publiés par l'application Datadog Slack elle-même ne déclenchent pas de workflows.
  1. Ajoutez un déclencheur Slack à votre workflow :
    • Si votre workflow ne possède aucun déclencheur, cliquez sur Add Trigger > Slack.
    • Si votre workflow possède déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur Slack comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Slack.
  2. Dans l’onglet Configure, sous Message triggers, sélectionnez le Workspace Slack.
  3. Sélectionnez un ou plusieurs Channels à écouter.
  4. Choisissez un Match type :
    • Any message : Chaque message dans les canaux sélectionnés déclenche le workflow.
    • Contains text : Le message doit contenir le texte que vous saisissez dans Message pattern. La correspondance ne tient pas compte de la casse.
    • Matches regular expression : Le message doit correspondre à l’expression régulière que vous saisissez dans Message pattern. La correspondance tient compte de la casse, et le motif peut correspondre n’importe où dans le message. Pour faire correspondre le message entier, utilisez ^ et $, par exemple ^deploy\s+production$. Pour ignorer la casse, ajoutez (?i) au début du motif.
  5. Optionnellement, filtrez les messages pris en compte :
    • Thread replies : Include all messages, Only thread replies ou Exclude thread replies.
    • App messages : Include all messages, Only app messages ou Exclude app messages.
  6. Pour écouter différents motifs ou canaux, cliquez sur Add message rule. Si un message correspond à plusieurs règles, le workflow s’exécute une seule fois.
  7. Cliquez sur Save, puis sur Publish.

Accédez au message Slack

Dans les étapes ultérieures de votre workflow, utilisez Source.slack_message pour référencer le message qui a déclenché le workflow :

VariableDescription
Source.slack_message.textLe texte du message.
Source.slack_message.user_idL’identifiant Slack de l’utilisateur qui a publié le message, lorsqu’il est présent.
Source.slack_message.channel_idL’identifiant Slack du canal dans lequel le message a été publié.
Source.slack_message.team_idL’identifiant Slack de l’espace de travail.
Source.slack_message.message_tsL’horodatage Slack du message.
Source.slack_message.thread_tsL’horodatage Slack du message parent, lorsque le message est une réponse dans un fil de discussion.
Source.slack_message.app_idL’identifiant Slack de l’application qui a publié le message, lorsque le message a été publié par une application.
Source.slack_message.bot_idL’identifiant Slack du bot qui a publié le message, lorsque le message a été publié par un bot.

Déclencheurs d’API

Le déclenchement d’un workflow à l’aide d’un appel API nécessite une clé d’API et une clé d’application avec le périmètre workflows_run. Pour plus d’informations sur l’ajout d’un périmètre à une clé d’application, consultez Périmètres.

Les clés sans périmètre n'incluent pas le workflows_run périmètre par défaut. Assurez-vous de suivre les meilleures pratiques de sécurité et d'utiliser une clé d'application avec les périmètres minimaux nécessaires pour effectuer la tâche souhaitée.

Vous pouvez déclencher un workflow en envoyant une requête POST avec l’identifiant du workflow vers l’endpoint https://api.datadoghq.com/api/v2/workflows/WORKFLOW-ID/instances. Lorsque vous ajoutez un déclencheur d’API à un workflow, l’interface du déclencheur vous fournit un exemple de requête cURL que vous pouvez utiliser pour déclencher le workflow.

Pour ajouter un déclencheur d’API à un workflow :

  1. Cliquez sur Add Trigger > API.

  2. Sur le canevas du workflow, cliquez sur API et notez l’exemple de requête cURL pour le workflow, qui inclut les en-têtes et les données requises pour déclencher votre workflow.

    Une requête cURL pour déclencher un workflow ressemble à ceci:

    curl -X POST \
      -H "Content-Type: application/json" \
      -H "DD-API-KEY: ${DD_API_KEY}" \
      -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
      -d {} \
      https://api.datadoghq.com/api/v2/workflows/32866005-d275-4553-be86-9f1b13066d84/instances

    Si le workflow inclut des paramètres d’entrée, incluez-les dans la charge utile de la requête. L’exemple suivant utilise deux paramètres d’entrée, example_input1 et example_input2:

    curl -X POST \
      -H "Content-Type: application/json" \
      -H "DD-API-KEY: ${DD_API_KEY}" \
      -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
      -d { "meta": { "payload": { \
        "example_input1": "...", \
        "example_input2": "..." \
      } } } \
      https://api.datadoghq.com/api/v2/workflows/32866005-d275-4553-be86-9f1b13066d84/instances
       
  3. Cliquez sur Save.

  4. Cliquez sur Publish pour publier le workflow. Un workflow doit être publié avant que vous puissiez le déclencher avec une requête POST. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Accédez au corps de la requête API

Dans les étapes ultérieures de votre workflow, utilisez Source.api.requestBody pour référencer la charge utile de la requête API entrante. Si le corps de la requête est au format JSON, analysez-le avec JSON.parse() avant d’accéder aux champs individuels. Par exemple, utilisez ${JSON.parse(Source.api.requestBody).my_field} au lieu de Source.api.requestBody.my_field.

Déclencheurs planifiés

Pour planifier l’exécution d’un workflow :

  1. Sur le canevas du workflow, cliquez sur Add an Automated Trigger et sélectionnez Schedule.
  2. Cliquez sur Create pour créer un compte de service. Pour plus d’informations, consultez Exécuter en tant que compte de service.
  3. Saisissez une heure et une fréquence pour l’exécution.
  4. (Facultatif) Saisissez une description pour le workflow dans le champ Memo.
  5. Cliquez sur Save.
  6. Cliquez sur Publish. Les workflows planifiés ne s’exécutent pas tant que vous ne les avez pas publiés. Les workflows publiés génèrent des coûts basés sur les exécutions de workflow. Pour plus d’informations, consultez la page de tarification Datadog.

Déclencher un workflow à partir d’un workflow

Vous pouvez déclencher un workflow enfant à partir d’un autre workflow en utilisant l’action Trigger Workflow. Par exemple, si vous avez une série complexe d’étapes que vous devez réutiliser dans plusieurs workflows, il n’est pas nécessaire de recréer ces étapes pour tous vos workflows. Au lieu de cela, ajoutez les étapes à un nouveau workflow et déclenchez-le dans vos autres workflows en utilisant l’action Déclencher le workflow.

À des fins de facturation, le déclenchement d'un workflow enfant est comptabilisé comme une nouvelle exécution de workflow.

Si le workflow enfant possède des paramètres d’entrée, ces paramètres apparaissent comme des champs requis dans l’action Déclencher le workflow. Dans l’exemple ci-dessous, le paramètre d’entrée service_name est requis car service_name est défini comme paramètre d’entrée dans le workflow enfant.

Le paramètre d'entrée service_name est requis dans le workflow enfant

Accéder au résultat d’un workflow enfant

Vous pouvez renvoyer le résultat d’un workflow enfant vers le workflow parent en définissant Output parameters dans le workflow enfant. Utilisez la variable de contexte WorkflowOutputs dans le workflow parent pour récupérer les paramètres de sortie du workflow enfant. Par exemple, étant donné un workflow enfant nommé Example_workflow avec un paramètre de sortie nommé exampleList, utilisez Steps.Example_workflow.workflowOutputs.exampleList pour accéder au résultat du workflow enfant.

Historique d’exécution

Après avoir déclenché un workflow, la page du workflow passe à la Run History du workflow. Cliquez sur Configuration ou Run History en haut à gauche pour basculer entre les vues de configuration et d’historique d’exécution. Utilisez l’historique d’exécution pour suivre la progression d’un workflow déclenché ou déboguer une étape ayant échoué.

Pour aller plus loin


Avez-vous des questions ou des commentaires ? Rejoignez le canal #workflows sur le Slack de la communauté Datadog.