Skip to content

Alert

Alerts can be configured to help users receive feedback from their data testing results. Currently, Data Caterer supports Slack for alerts.

Slack

Define a Slack token and one or more Slack channels that will receive an alert like the below.

Slack alert sample

var conf = configuration()
    .slackAlertToken("abc123")                                //use appropriate Slack token (usually bot token)
    .slackAlertChannels("#test-alerts", "#pre-prod-testing"); //define Slack channel(s) to receive alerts on

execute(conf, ...);

val conf = configuration
  .slackAlertToken("abc123")                                //use appropriate Slack token (usually bot token)
  .slackAlertChannels("#test-alerts", "#pre-prod-testing")  //define Slack channel(s) to receive alerts on

execute(conf, ...)

In a unified YAML file: 

config:
  flags:
    enableAlerts: true
  alert:
    triggerOn: "onFailure"  # onFailure | onCompletion | always
    slackToken: "abc123"
    slackChannels:
      - "#test-alerts"
      - "#pre-prod-testing"


flags {
  enableAlerts = true
}
alerts {
  triggerOn = "onFailure"  # onFailure | onCompletion | always
  slack {
    token = "abc123"
    channels = ["#test-alerts", "#pre-prod-testing"]
  }
}

Trigger conditions

Control when alerts are sent based on execution results.

configuration()
  .enableAlerts(true)
  .alertTriggerOn("onFailure"); // options: onFailure | onCompletion | always

configuration
  .enableAlerts(true)
  .alertTriggerOn("onFailure") // options: onFailure | onCompletion | always

In a unified YAML file: 

config:
  flags:
    enableAlerts: true
  alert:
    triggerOn: "onFailure"  # onFailure | onCompletion | always


flags {
  enableAlerts = true
}
alerts {
  triggerOn = "onFailure"  # onFailure | onCompletion | always
}