Check Status Widget

Check Status Widget

Check status shows the current status or number of results for any check performed:

Setup

Configuration

  1. Select a previously created service check.

  2. Choose a reporting time frame. This time frame always includes up to the present, so you can choose an option such as The past 10 minutes or The past 1 day and it reports a status that includes that time frame up to the present moment. If you choose Global Time, the person using the dashboard can select a range using the time frame selector in the upper right, but they must choose one that includes the present moment, that is any past X time frame. Otherwise the widget will be blank.

  3. Choose your scope:

    • A single check: Select this option if your Check Status widget is for a specific element only, for example: one host:<HOSTNAME>, one service:<SERVICE_NAME>, etc.
    • A cluster of checks: Select this option if your Check Status widget is for a scope of elements i.e all hosts, all services, etc.
  4. After selecting your scope, define your Check Status widget context with the Reported by field.

  5. Optional: group your checks result according to a custom tag key.

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 check status widget is:

Expand All

Field

Type

Description

check [required]

string

Name of the check to use in the widget.

group

string

Group reporting a single check.

group_by

[string]

List of tag prefixes to group by in the case of a cluster check.

grouping [required]

enum

The kind of grouping to use. Allowed enum values: check,cluster

tags

[string]

List of tags used to filter the groups reporting a cluster check.

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

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 check status widget. Allowed enum values: check_status

{
  "check": "",
  "group": "string",
  "group_by": [],
  "grouping": "check",
  "tags": [],
  "time": {
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "check_status"
}

Further Reading