Skip to content

Workflow Alerting

The workflow alerting package provides additional alerting options for workflow tracking - including support for email notifications and messages to Google Chat spaces. Workflow alerting options over Slack and Microsoft Teams are available out-of-the-box.

Configuration

  • Mode : Select the mode of notification to receive workflow alerts.
    • Email : When selected, receive a tabular report for workflow runs.
      • Email id : Enter a valid email-id to receive workflow alerts. (required for notification mode - Email)

      How to provide multiple email-ids for alerting

      To enable the email alerts for more than one email-id, separate the email-ids with a (,) comma in the Email id field. e.g.: atlan.example1@atlan.com,atlan.example2@atlan.com,...

    • Google Chat : When selected, receive a google card report for workflow runs.
  • Notification Scope : Select the scope for notification based on workflow status.
    • Failed/Stopped : Select this to receive alerts for only failed/stopped workflows.
    • All Workflows : Select this to receive alerts for all workflows.
  • Custom workflows : Select the type of workflow packages you want to track by including custom workflows or by excluding them.
    • Yes : To include custom workflows in the alert reports.
    • No : To exclude custom workflows in the alert reports.
  • Scheduled Workflows : Select this to get alerts either only for scheduled workflows or to get alert for both manual and scheduled workflows.
    • Yes : To include scheduled workflows only.
    • No : To have both manual and scheduled workflow.
  • Monitoring Interval : Select the monitoring interval for workflow run time filter.
    • Last 1 Hour : Checks for workflows that completed/failed in the last 1 hour - from the time this workflow starts running.
    • Last 24 Hour : Checks for workflows that completed/failed in the last 24 hour - from the time this workflow starts running.
    • Last 7 Days : Checks for workflows that completed/failed in the last 7 days - from the time this workflow starts running.
    • Last 30 Days : Checks for workflows that completed/failed in the last 30 days - from the time this workflow starts running.
    • Date Range : Requires a start date. Generates alert report for all the workflows (after including the above filters) that completed/failed after the selected start date.
When are notifications generated?

Notification messages are generated when workflow runs are found for the selected filters. For successful workflow alerting runs that did not send any messages, check Argo logs to see if there was any workflow report for the run.

What it does

Send a report for workflow runs based on all the filters selected in the config. Can be used with a schedule to send notification like alerts for workflows or can be used as a manual package to get a report for desired time period on workflow runs.

How it works
  • Searches for the names of existing workflows in the tenant after applying the custom and scheduled filters.
  • Looks for all the runs for these extracted workflows in the tenant with time and status filters for the workflow runs.
  • Sends an Email or a Google Chat message with all the workflow run details.