Alert tasks

Preview

This feature is in Public Preview. Contact your Databricks representative to request access.

Create an alert

  1. Do one of the following:

    • Click the Create Icon icon in the sidebar and select Alert.
    • Click the Alerts Icon icon in the sidebar and click the + New Alert button.
  2. Search for a target query. If you don’t see it the one you want, make sure it is published and does not use parameters.

    Target query
  3. In the Trigger when field, configure the alert.

    • The Value column drop-down controls which field of your query result is evaluated.
    • The Condition drop-down controls the logical operation to be applied.
    • The Threshold text input is compared against the Value column using the Condition you specify.
    Alert settings

    Note

    If a target query returns multiple records, SQL Analytics alerts act on the first one. As you change the Value column setting, the current value of that field in the top row is shown beneath it.

  4. In the When triggered, send notification field, select how many notifications are sent when your alert is triggered:

    • Just once: Send a notification when the alert status changes from OK to TRIGGERED.
    • Each time alert is evaluated: Send a notification whenever the alert status is TRIGGERED regardless of its status at the previous evaluation.
    • At most every: Send a notification whenever the alert status is TRIGGERED at a specific interval. This choice lets you avoid notification spam for alerts that trigger often.

    Regardless of which notification setting you choose, you receive a notification whenever the status goes from OK to TRIGGERED or from TRIGGERED to OK. The schedule settings affect how many notifications you will receive if the status remains TRIGGERED from one execution to the next. For details, see Notification frequency.

  5. In the Template drop-down, choose a template:

    • Use default template: Alert notification is a message with links to the Alert configuration screen and the Query screen.

    • Use custom template: Alert notification includes more specific information about the alert.

      1. A box displays, consisting of input fields for subject and body. Any static content is valid, and you can incorporate built-in template variables:

        • ALERT_STATUS: The evaluated alert status (string).
        • ALERT_CONDITION: The alert condition operator (string).
        • ALERT_THRESHOLD: The alert threshold (string or number).
        • ALERT_NAME: The alert name (string).
        • ALERT_URL: The alert page URL (string).
        • QUERY_NAME: The associated query name (string).
        • QUERY_URL: The associated query page URL (string).
        • QUERY_RESULT_VALUE: The query result value (string or number).
        • QUERY_RESULT_ROWS: The query result rows (value array).
        • QUERY_RESULT_COLS: The query result columns (string array).

        An example subject, for instance, could be: Alert "{{ALERT_NAME}}" changed status to {{ALERT_STATUS}}.

      2. Click the Preview toggle button to preview the rendered result.

        Important

        The preview is useful for verifying that template variables are rendered correctly. It is not an accurate representation of the eventual notification content, as each alert destination can display notifications differently.

      3. Click the Save Changes button.

  6. Click Create Alert.

  7. Choose an alert destination.

    Important

    If you skip this step you will not be notified when the alert is triggered.

    Alert destination

Notification frequency

SQL Analytics sends notifications to your chosen alert destinations whenever it detects that the Alert status has changed from OK to TRIGGERED or vice versa. Consider this example where an Alert is configured on a query that is scheduled to run once daily. The daily status of the Alert appears in the following table. Prior to Monday the alert status was OK.

Day Alert Status
Monday OK
Tuesday OK
Wednesday TRIGGERED
Thursday TRIGGERED
Friday TRIGGERED
Saturday TRIGGERED
Sunday OK

If the notification frequency is set to Just Once, SQL Analytics sends a notification on Wednesday when the status changed from OK to TRIGGERED and again on Sunday when it switches back. It does not send alerts on Thursday, Friday, or Saturday unless you specifically configure it to do so because the Alert status did not change between executions on those days.

Configure alert permissions

To configure who can manage and run alerts, see Alert access control.