Alert Value Widget

Alert Value Widget

Alert values are query values showing the current value of the metric in any monitor defined on your system:

Setup

Configuration

  1. Choose a previously created monitor to graph.
  2. Select the formatting to display:
    • raw value
    • 0/1/2/3 decimals
  3. Select to display:
    • Automatic
    • /s Per Second
    • b Bits
    • B Bytes
    • Custom

Options

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 value widget is:

Expand All

Field

Type

Description

alert_id [required]

string

ID of the alert to use in the widget.

precision

int64

Number of decimal to show. If not defined, will use the raw value.

text_align

enum

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

title

string

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 value in the widget.

type [required]

enum

Type of the alert value widget. Allowed enum values: alert_value

unit

string

Unit to display with the value.

{
  "alert_id": "",
  "precision": "integer",
  "text_align": "string",
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "alert_value",
  "unit": "string"
}

Further Reading