Overview
The Run Workflow widget allows you to automate critical tasks from dashboards. Trigger your workflows from a dashboard at the point you become aware of an issue affecting the health of your system. This keeps your systems up and running by improving the time to resolution and reducing the possibility of errors.
Configuration
- Under Select the workflow, find your workflow in the dropdown menu.
- Map dashboard template variables to workflow input parameters. This allows the values of your dashboard template variables to be mapped directly to the input parameters when you run the workflow.
- Enter a title for the widget and click Save.
To run the workflow:
- Click Run Workflow on your dashboard widget.
- Under Execution parameters, any template variables you mapped to workflow inputs are automatically populated. Enter the values for any unmapped execution parameters, or edit the existing values if needed.
- Click Run to run the workflow.
API
This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:
Expand All
The flag for toggling context menu link visibility.
The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.
The URL of the custom link. URL must include http or https. A relative URL must start with /.
The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.
Array of workflow inputs to map to dashboard template variables.
Name of the workflow input.
Dashboard template variable. Can be suffixed with '.value' or '.key'.
Time setting for the widget.
The available timeframes depend on the widget you are using.
Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert
Used for arbitrary live span times, such as 17 minutes or 6 hours.
Type "live" denotes a live span in the new format.
Allowed enum values: live
Unit of the time span.
Allowed enum values: minute,hour,day,week,month,year
Used for fixed span times, such as 'March 1 to March 7'.
Start time in seconds since epoch.
End time in seconds since epoch.
Type "fixed" denotes a fixed span.
Allowed enum values: fixed
How to align the text on the widget.
Allowed enum values: center,left,right
Type of the run workflow widget.
Allowed enum values: run_workflow
default: run_workflow
{
"custom_links": [
{
"is_hidden": false,
"label": "Search logs for {{host}}",
"link": "https://app.datadoghq.com/logs?query={{host}}",
"override_label": "logs"
}
],
"inputs": [
{
"name": "Environment",
"value": "$env.value"
}
],
"time": {
"live_span": "5m"
},
"title": "string",
"title_align": "string",
"title_size": "string",
"type": "run_workflow",
"workflow_id": "<workflow_id>"
}
Further reading
Additional helpful documentation, links, and articles:
