Alert Graph Widget

Alert Graph Widget

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

This widget is supported for metric, anomaly, outlier, forecast, APM, and integration monitors.

Setup

Configuration

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

Options

Display preference

Global time

On screenboards only, choose whether your widget has a custom timeframe or the screenboard’s global timeframe.

Legend

Use Show legend on graph to toggle the legend display on your widget. Optionally, select the number of entries to display.

Title

Display a custom title for your widget by activating the Show a Title check box:

Optionally define its size and alignment.

API

This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.

The dedicated widget JSON schema definition for the alert graph widget is:

Expand All

Field

Type

Description

alert_id [required]

string

ID of the alert to use in the widget.

time

object

Time setting for the widget.

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,1y,alert

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

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