Widget Run Workflow

Información general

El widget Run Workflow te permite automatizar tareas críticas desde dashboards. Activa tus flujos de trabajo desde un dashboard en el momento en que tengas conocimiento de un problema que afecte a la salud de tu sistema. Esto mantiene tus sistemas en funcionamiento, mejora el tiempo de resolución y reduce la posibilidad de errores.

Configuración

  1. En Select the workflow (Seleccionar el flujo de trabajo), busca tu flujo de trabajo en el menú desplegable.
  2. Asigna variables de plantilla de dashboard a los parámetros de entrada del flujo de trabajo. Esto permite que los valores de tus variables de plantilla de dashboard se asignen directamente a los parámetros de entrada al ejecutar el flujo de trabajo.
  3. Introduce un título para el widget y haz clic en Save (Guardar).
Haz clic en Run Workflow para activar un flujo de trabajo desde el widget Dashboard.

Para ejecutar el flujo de trabajo:

  1. Haz clic en Run Workflow en tu widget de dashboard.
  2. En Execution parameters (Parámetros de ejecución), cualquier variable de plantilla que hayas asignado a las entradas del flujo de trabajo se rellena automáticamente. Introduce los valores de los parámetros de ejecución no asignados o edita los valores existentes si es necesario.
  3. Haz clic en Run (Ejecutar) para ejecutar el flujo de trabajo.

API

Este widget puede utilizarse con la Dashboards API (API de dashboards). Ve la siguiente tabla para la widget JSON schema definition (definición de esquema de JSON de widget):

Expand All

Field

Type

Description

custom_links

[object]

List of custom links.

is_hidden

boolean

The flag for toggling context menu link visibility.

label

string

The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables.

link

string

The URL of the custom link. URL must include http or https. A relative URL must start with /.

override_label

string

The label ID that refers to a context menu link. Can be logs, hosts, traces, profiles, processes, containers, or rum.

inputs

[object]

Array of workflow inputs to map to dashboard template variables.

name [required]

string

Name of the workflow input.

value [required]

string

Dashboard template variable. Can be suffixed with '.value' or '.key'.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

live_span

enum

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

Option 2

object

Used for arbitrary live span times, such as 17 minutes or 6 hours.

type [required]

enum

Type "live" denotes a live span in the new format. Allowed enum values: live

unit [required]

enum

Unit of the time span. Allowed enum values: minute,hour,day,week,month,year

value [required]

int64

Value of the time span.

Option 3

object

Used for fixed span times, such as 'March 1 to March 7'.

from [required]

int64

Start time in seconds since epoch.

to [required]

int64

End time in seconds since epoch.

type [required]

enum

Type "fixed" denotes a fixed span. Allowed enum values: fixed

title

string

Title of your widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the run workflow widget. Allowed enum values: run_workflow

default: run_workflow

workflow_id [required]

string

Workflow id.

{
  "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>"
}

Leer más

Additional helpful documentation, links, and articles: