Edge Delta Workflows

Overview

A workflow connects inputs, processors, filters, and outputs to create data processes. Each component is configured outside of the workflow in its own section in the agent yaml. The workflow references the component by name or label.

See the instructions for configuring an agent.

Example

workflows:
  error-anomaly-workflow:
    input_labels:
      - errorcheck
    filters:  
      - error
    processors:
      - error-regex
    destinations:
      - pagerduty-integration

Expiring Workflows

To define an expiring workflow, set an expiration time in the workflow definition with the expires_in parameter.

With an expiring workflow, you can also enable log forwarding for a specified time with the log_forward_workflow parameter.

Note The “expires_in” time format must be in RFC3339 format.

workflows:
  log_forward_workflow:
    input_labels:
      - system_stats
      - agent_stats
      - application_logs
    filters:
      - not_debug
    destinations:
      - sumo-logic-devops-integration
    expires_in: 2021-06-01T12:00:00.000Z

Configure a Conditional Workflow

A conditional workflow will only trigger when all the conditions that you have configured are met.

To define a conditional workflow, use the conditions parameter.

conditional-workflow:
  input_labels:
    - errorcheck
  conditions:
    - type: on_demand_log_forward
    name: alert_on_my_service
  destinations:
    - '{{ Env "TEST_SUMO" }}'

Parameters

name

Required

Enter a descriptive name for the workflow.

A workflow name is used for labeling and organizing workflows within a configuration.

A workflow name is not reported to any destination.

billing-cluster-workflow:

input_labels

Required

This parameter displays existing inputs that you can add to the workflow.

To learn more, see Inputs.

input_labels:
  - billing

processors

Optional

This parameter displays existing processors that you can add to the workflow.

To learn more, see Processors.

processors:
  - clustering

destinations

Optional

This parameter displays existing outputs that you can add to the workflow.

To learn more, see Outputs.

destinations:
      - datadog-default

enabled_hosts

Optional

You can use this parameter to limit the workflow to specific hosts.

With this parameter, the workflow will only run if the agent host is specified.

enabled_hosts:
  - my.host.us1
  - my.host.us2

thresholds

Optional

This parameter displays existing thresholds that you can add to the workflow.

To learn more, see Thresholds

thresholds:
  - cluster-errors-threshold

expires_in

Optional

This parameter expires a workflow based on the specified timestamp.

You must enter a timestamp in a UTC format.

expires_in: 2021-06-01T12:00:00.000Z

filters

Optional

This parameter displays existing filters that you can add to the workflow.

The filter step takes place before incoming logs are passed to the processors.

To learn more, see Filters.

filters:
  - info

description

Optional

Enter a brief description to describe the purpose of the workflow.

description: "runs only specified hosts"