Monitor a metric

You monitor metrics to stay aware of data quality issues the metrics uncover.

❗️

The procedures on this page require the Workspace Editor role, unless otherwise noted at the top of the procedure.

  • A metric periodically calculates values from a data asset and aggregates those results into a single value.
  • A monitor provides a mechanism for generation of incidents when a metric value deviates from desired bounds.
  • A monitor is associated with a single metric and defines which metric values are “out of bounds”.
  • As time goes on, if a monitor is attached to a metric, the monitor will generate incidents when the metric value is found to be out of bounds.
  • A monitor may be either a manual monitor, in which case the bounds are specified explicitly by the data analyst, or an anomaly monitor, in which case the bounds are generated by looking at the historical norms for the metric.
  • Anomaly monitors must be trained based on past data. The training data can be a single period or multiple non-contiguous periods. You can make your monitor "learn" by rejecting incidents that are false positives or by adjusting the training periods.

Create a monitor

  1. On the metric's chart in Explorer, select Monitors -> + Add monitor.
  2. If the Add Monitor modal includes Threshold/Anomaly Detection buttons, choose Threshold to manually provide upper and lower bounds for the value, or choose Anomaly Detection to have the monitor observe the metric for a while and automatically decide what's abnormal. If you're just getting started with a datasource, it's a good idea to specify date ranges that have "normal" metric values to use for training the monitor. To do so, select the manually create a monitor link in the modal, and then follow the steps to Train a monitor. Once thresholds are established, metric values below the lower bound or above the upper bound will cause incidents.
  3. If you have an alerting channel ready and want incidents to generate alerts there, enter it under Select the channels to send notifications. You can also manage alerting channels later, after the monitor is working.
  4. Optionally, move the Mute toggle to the right to prevent the monitor from generating alerts.
  5. Click OK to save the new monitor and begin any training. After you finish setting up, the monitor detects when its metric's value is out of bounds and logs variations as incidents. A monitor can bundle consecutive variations as one incident or record them as separate incidents.

Pause/Resume a monitor

On the metric's chart in Explorer, do one of the following:

  • Select Monitors → Pause → name-of-the-monitor .
  • Select Monitors → Resume → name-of-the-monitor .

Manage a monitor's alerting channels

  1. On the metric's chart in Explorer, select Monitors → Manage alerts → name-of-the-monitor .
  2. In the Notification Channels modal, click the box to select one or more existing alerting channels. As needed, adjust the Mute toggle. Note that a muted monitor stops sending alerts to all channels; to stop receiving alerts for a specific channel, remove it from the selected channels in the Notification Channels modal.

Train a monitor

Although you can let a monitor train itself, it will perform better if you give it some time periods during which metric values are all normal (i.e., no cause for an incident/alert).

🚧

Before you begin

The modal for adding training periods doesn't provide a view of the metric's history. You should review the metric's history yourself and make note of one or more date ranges that have all "normal" values and when considered together capture any typical variations. Then, use the date ranges you've identified when you edit the monitor.

  1. With the data asset selected in Explorer, find the metric in the pane to the right of the Explorer tree.
  2. On the metric's Monitors menu, select Edit. If there are several monitors, you'll also have to select the one you want to edit.
  3. Near the top left corner of the main page, select Train, and then under Training select +.
12591259
  1. In the modal that opens, specify a start and end for the training period, then select OK. Repeat to add as many ranges as you need to make sure the monitor trains using the whole range of normal behavior.
  2. When you've added the ranges you want, at the bottom left select Save and train.

The Monitors list

With a workspace selected, select Monitors on the top bar to open the Monitors list: an easy way to work with all the monitors in the workspace.

14001400
  • Assess monitors at a glance— tiles across the top display summary information about monitors in the workspace:
    • Total (count of monitors)
    • Monitored Metrics (metrics with at least one monitor attached)
    • Live (monitors currently active)
    • Paused (monitors currently paused for any reason)
    • Failed Training (monitors stopped because training failed)
    • Alerting (live, unmuted monitors)
  • Just above the list items, controls let you work with the list:
    • Search for a monitor.
    • Add Monitor +.
    • Show x sets how many rows to display per page (in general, fewer is faster).
    • Select the gear icon to choose what columns to display.
    • Navigation arrows and page numbers let you jump around in the list.
  • In the list header, you have more options for working with list items:
    • Select the check box to select all items on the page.
    • Select a column heading to sort the list using the column's values in ascending order. Select it again to reverse the sort order. Select it a third time to stop sorting.
  • In the Name column, select a value to open the context menu for the monitor.
  • In the Metric column, select a value to open that metric in Explorer.