This product is not supported for your selected Datadog site. ().
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 depuis diverses sources différentes, comme un monitor Datadog et un dashboard Datadog.
Un workflow peut soit s’exécuter avec l’identité de l’utilisateur qui en est propriétaire, soit avec l’identité d’un compte de service associé au workflow. Pour obtenir plus d’informations sur les comptes de service, consultez la section Comptes de service pour Workflow Automation.
Déclencheurs manuels
Pour déclencher un workflow manuellement :
Depuis la page du workflow, cliquez sur Run.
Saisissez les valeurs pour les variables de déclencheur existantes.
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 :
Depuis votre dashboard, cliquez sur Add Widget.
Recherchez workflows et ajoutez le widget Run Workflow.
Sous Select the workflow, trouvez votre workflow dans le menu déroulant. Seuls les workflows publiés avec des déclencheurs de dashboard apparaissent dans la liste.
Mappez des template variables de dashboard aux paramètres d’entrée de votre workflow. De cette manière, les valeurs de vos template variables de dashboard sont associées directement aux paramètres d’entrée lors de l’exécution du workflow.
Attribuez un titre au widget, puis cliquez sur Save.
Pour exécuter le workflow, procédez comme suit :
Cliquez sur Run Workflow dans votre widget de dashboard.
Les template variables que vous avez mappées aux entrées du workflow s’affichent automatiquement sous Execution parameters. Saisissez les valeurs des paramètres d’exécution qui ne sont pas mappés ou modifiez des valeurs existantes si nécessaire.
Cliquez sur Run pour exécuter le workflow.
Déclencheurs de monitor
Ajouter un déclencheur de monitor à votre workflow
Ajoutez un déclencheur de monitor à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > Monitor.
Si votre workflow a déjà un ou plusieurs déclencheurs et que vous ajoutez le monitor comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Monitor.
Assurez-vous que le déclencheur est connecté à une étape dans le workflow. Vous pouvez connecter le déclencheur à une étape en cliquant et en faisant glisser l’icône plus (+) sous le déclencheur.
Cliquez sur le déclencheur et prenez note du Mention handle.
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, basculez l’option Automatic triggering.
Enregistrez votre workflow.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Trouvez le monitor que vous souhaitez utiliser pour déclencher le workflow et modifiez-le, ou créez un nouveau monitor.
Dans la section Configure notifications & automations, cliquez sur + Add Workflow.
Utilisez le nom de mention du workflow pour rechercher votre workflow et sélectionnez-le dans le menu déroulant. Seuls les workflows avec des déclencheurs de monitor apparaissent dans la liste. Une mention pour le monitor apparaît dans le champ de 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.
Si le workflow prend des paramètres d’entrée :
Cliquez sur Configure Inputs à côté du nom et de l’ID du monitor.
Saisissez les valeurs pour les paramètres d’entrée. Remarque : les valeurs peuvent inclure des variables de modèle de message de monitor. Pour voir une liste des variables disponibles, cliquez sur Use Message Template Variables dans le coin supérieur droit de la section Configure notifications & automations. Les paramètres se remplissent dans la mention dans le champ de message de notification. Par exemple, si vous configurez un workflow nommé @workflow-test-inputs pour avoir les paramètres suivants :
la mention devient @workflow-test-inputs(im_a_string="abc", im_a_number=123, im_a_boolean=true, i_have_a_default_value="override this").
Enregistrez le monitor.
Chaque fois que le seuil du monitor est atteint, le monitor déclenche une exécution de workflow.
Pour déclencher un workflow depuis une règle de notification d’incident, vous devez d’abord ajouter un déclencheur d’incident à votre workflow :
Ajoutez un déclencheur d’incident à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > Incident.
Si votre workflow a déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur de sécurité comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Incident.
Assurez-vous que le déclencheur est connecté à une étape dans le workflow. Vous pouvez connecter le déclencheur à une étape en cliquant et en faisant glisser l’icône plus (+) sous le déclencheur.
Cliquez sur le déclencheur et prenez note du Mention handle.
Les déclencheurs d’incident sont configurés pour se déclencher automatiquement par défaut. Si vous ne souhaitez pas que le workflow se déclenche automatiquement, basculez l’option Automatic triggering.
Enregistrez votre workflow.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Ajoutez le workflow à votre règle de notification d’incident :
Configurez une Severity, un Service et d’Other attributes pour votre règle de notification.
Sous Notify, collez le handle du workflow que vous avez copié précédemment.
Dans la section Recipient, utilisez le nom de mention du workflow pour trouver votre workflow. Par exemple, @workflow-my-workflow. Le workflow doit avoir un déclencheur d’incident avant que vous puissiez le déclencher depuis un incident.
Saisissez un Template et configurez les paramètres Renotify pour la règle de notification.
Cliquez sur Save.
Déclencheurs de sécurité
Vous pouvez déclencher un workflow automatiquement pour tout Security Signal, ou déclencher manuellement un workflow depuis un panneau de Security Signal Cloud SIEM. Avant de pouvoir ajouter un workflow à un Security Signal, le workflow doit avoir un déclencheur de sécurité.
Déclencheurs de règle de notification de Security Signal
Vous pouvez configurer un workflow pour qu’il se déclenche chaque fois qu’une règle de notification de Security Signal se déclenche.
Pour déclencher un workflow depuis une règle de notification, vous devez d’abord ajouter un déclencheur de sécurité à votre workflow :
Ajoutez un déclencheur de sécurité à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > Security.
Si votre workflow a déjà un ou plusieurs déclencheurs et que vous ajoutez le déclencheur de sécurité comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Security.
Assurez-vous que le déclencheur est connecté à une étape dans le workflow. Vous pouvez connecter le déclencheur à une étape en cliquant et en faisant glisser l’icône plus (+) sous le déclencheur.
Cliquez sur le déclencheur et prenez note du Mention handle.
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, basculez l’option Automatic triggering.
Enregistrez votre workflow.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Ajoutez le workflow à votre règle de notification :
Depuis la page Configuration, trouvez la règle de notification que vous souhaitez utiliser pour déclencher votre workflow, ou créez une nouvelle règle.
Dans la section Recipient, utilisez le nom de mention du workflow pour trouver votre workflow. Par exemple, @workflow-my-workflow.
Sélectionnez le workflow dans le menu déroulant. Seuls les workflows avec des déclencheurs de sécurité apparaissent dans la liste.
Cliquez sur Save.
Chaque fois que la règle de notification se déclenche, elle déclenche une exécution de workflow.
Déclencheurs de Security Signal Cloud SIEM
Vous pouvez démarrer manuellement un workflow depuis un panneau de Security Signal Cloud SIEM.
Cliquez sur Run Workflow en haut du panneau Security Signal.
Dans la fenêtre 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.
Si votre workflow nécessite des paramètres d’entrée, saisissez les valeurs comme requis. Vous pouvez copier les valeurs depuis le JSON de l’objet Signal affiché à côté des paramètres d’entrée, et les coller dans les champs de paramètres.
Cliquez sur Run.
Vous pouvez voir le statut d’exécution du workflow dans la section Workflow du Security Signal.
Pour exécuter un workflow depuis une entité de Software Catalog, vous devez d’abord ajouter un déclencheur de Software Catalog à votre workflow :
Ajoutez un déclencheur de Software Catalog à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > Software Catalog.
Si votre workflow a déjà un ou plusieurs déclencheurs et que vous ajoutez le Software Catalog comme déclencheur supplémentaire, cliquez sur l’icône Add Trigger (éclair) et sélectionnez Software Catalog.
Assurez-vous que le déclencheur est connecté à une étape dans le workflow. Vous pouvez connecter le déclencheur à une étape en cliquant et en faisant glisser l’icône plus (+) sous le déclencheur.
Enregistrez votre workflow.
Cliquez sur Publish pour publier votre workflow. Les workflows publiés engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Exécutez le workflow depuis votre entité Software Catalog :
Cliquez sur Run Workflow en haut du panneau latéral.
Dans la fenêtre de recherche, saisissez le nom du workflow que vous souhaitez exécuter et sélectionnez-le. Seuls les workflows avec des déclencheurs Software Catalog apparaissent dans la liste.
Si votre workflow nécessite des paramètres d’entrée, saisissez les valeurs comme requis.
Cliquez sur Run pour exécuter le workflow.
Déclencheurs GitHub
Votre compte GitHub doit avoir l'autorisation de créer des webhooks pour utiliser cette fonctionnalité.
Vous pouvez déclencher un workflow depuis GitHub en suivant les étapes suivantes.
Ajoutez un déclencheur GitHub à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > GitHub.
Si votre workflow a 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.
Accédez au référentiel GitHub que vous souhaitez utiliser pour déclencher votre workflow.
Dans GitHub, cliquez sur Settings, cliquez sur Webhooks, puis cliquez sur Add webhook.
Dans l’onglet Configure de votre workflow, copiez la Payload URL. Collez-la dans le champ Payload URL sur la page de création de webhook GitHub.
Dans GitHub, définissez le Content type de votre webhook sur application/json.
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.
Dans GitHub, choisissez les événements que vous souhaitez qui déclenchent votre webhook, puis cliquez sur Add webhook.
Facultativement, dans votre workflow, cliquez sur le plus (+) pour ajouter une Rate Limit.
Cliquez sur Save sur votre workflow.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Déclencheurs Slack
Vous devez installer l'application Datadog dans votre espace de travail Slack pour utiliser cette fonctionnalité. Pour obtenir plus d'informations, consultez la section 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 en suivant les étapes suivantes.
Ajoutez un déclencheur Slack à votre workflow :
Si votre workflow n’a aucun déclencheur, cliquez sur Add Trigger > Slack.
Si votre workflow a 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.
Assurez-vous que le déclencheur est connecté à une étape dans le workflow. Vous pouvez connecter le déclencheur à une étape en cliquant et en faisant glisser l’icône plus (+) sous le déclencheur.
Cliquez sur Save sur votre workflow.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
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éclencheurs d’API
Déclencher un workflow à l’aide d’un appel d’API nécessite une clé d’API et une clé d’application avec la portée workflows_run. Pour obtenir des informations sur l’ajout d’une portée à une clé d’application, consultez la section Portées.
Les clés sans portée n'incluent pas la portée workflows_run par défaut. Assurez-vous de suivre les bonnes pratiques de sécurité et d'utiliser une clé d'application avec les portées minimales nécessaires pour effectuer la tâche souhaitée.
Vous pouvez déclencher un workflow en envoyant une requête POST avec l’ID 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 donne un exemple de requête cURL que vous pouvez utiliser pour déclencher le workflow.
Pour ajouter un déclencheur d’API à un workflow :
Cliquez sur Add Trigger > API.
Sur le canevas du workflow, cliquez sur API et notez l’exemple de requête cURL du workflow, qui inclut les en-têtes et les données requis pour déclencher votre workflow.
Une requête cURL pour déclencher un workflow ressemble à quelque chose comme ceci :
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 :
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Déclencheurs planifiés
Pour planifier une exécution de workflow :
Sur le canevas du workflow, cliquez sur Add an Automated Trigger et sélectionnez Schedule.
Cliquez sur Create pour créer un compte de service. Pour obtenir plus d’informations, consultez la section Utiliser un compte de service.
Saisissez une heure et une fréquence pour l’exécution.
(Facultatif) Saisissez une description pour le workflow dans le champ Memo.
Cliquez sur Save.
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 engendrent des coûts en fonction des exécutions de workflow. Pour obtenir plus d’informations, consultez la page de la tarification de Datadog.
Déclencher un workflow depuis un workflow
Vous pouvez déclencher un workflow enfant depuis un autre workflow à l’aide de 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 à l’aide de l’action Trigger Workflow.
À des fins de facturation, déclencher un workflow enfant s'enregistre comme une nouvelle exécution de workflow.
Si le workflow enfant a des paramètres d’entrée, ces paramètres apparaissent comme des champs obligatoires dans l’action Trigger Workflow. Dans l’exemple ci-dessous, le paramètre d’entrée service_name est obligatoire car service_name est défini comme paramètre d’entrée dans le workflow enfant.
Accéder au résultat d’un workflow enfant
Vous pouvez transmettre le résultat d’un workflow enfant au workflow parent en définissant des 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 bascule vers le 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
Documentation, liens et articles supplémentaires utiles:
