Alert Graph Widget

Alert graphs are timeseries graphs showing the current status of most monitors defined on your system:

Alert Graph

This widget is supported in default scheduled query alert monitors such as metric, anomaly, outlier, forecast, APM, and integration.

Setup

Configuration

  1. Choose a previously created monitor to graph.
  2. Select a timeframe.
  3. Select your visualization:
    • Timeseries
    • Top list

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

Expand All

Field

Type

Description

alert_id [required]

string

ID of the alert to use in the widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert

Option 2

object

Used for arbitrary live span times, such as 17 minutes or 6 hours.

type [required]

enum

Type "live" denotes a live span in the new format. Allowed enum values: live

unit [required]

enum

Unit of the time span. Allowed enum values: minute,hour,day,week,month,year

value [required]

int64

Value of the time span.

Option 3

object

Used for fixed span times, such as 'March 1 to March 7'.

from [required]

int64

Start time in seconds since epoch.

to [required]

int64

End time in seconds since epoch.

type [required]

enum

Type "fixed" denotes a fixed span. Allowed enum values: fixed

title

string

The title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the alert graph widget. Allowed enum values: alert_graph

default: alert_graph

viz_type [required]

enum

Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: timeseries,toplist

{
  "alert_id": "",
  "time": {
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "alert_graph",
  "viz_type": "timeseries"
}

Further Reading

Additional helpful documentation, links, and articles:

PREVIEWING: rtrieu/product-analytics-ui-changes