Workflows

Workflows are YAML-based configurations designed to automate the response and add context to your issues. Each workflow consists of triggers, steps, and actions, which define when and how a workflow is executed and what tasks are performed.

Workflow components

Triggers

After uploading your workflow, it can be executed based on the trigger type. Workflows can be triggered in three ways - on-demand, as issues are identified, or in predefined intervals.

Manual Trigger

Executes workflows on-demand.

Example:

triggers:
  - type: manual

Issues Trigger

Automatically activates a workflow when an issues is identified by a monitoring source. You can filter issues based on their source or other attributes.

Example:

triggers:
  - type: alert

Interval Trigger

Automatically activates a workflow at specified time intervals, set in seconds.

Example:

triggers:
  - type: interval
    value: 10  # Time in seconds

Steps

Define a series of data-fetching or computation tasks that help enrich the workflow. Steps are optional but can be useful for adding context to your issues.

steps:
  - name: fetch-data
    action: http_request
    url: "<https://api.example.com/data>"

Actions

Actions specify what happens when a workflow is triggered. Actions can include notifications, data enrichment, or automation tasks. In groundcover, actions typically interface with external systems (like sending a Slack message).

actions:
  - type: notify
    provider: slack
    message: "An issues has been triggered!"