Check status shows the current status or number of results for any check performed:
Choose your scope:
host:<HOSTNAME>
, one service:<SERVICE_NAME>
, etc.host
s, all service
s, etc.After selecting your scope, define your Check Status widget context with the Reported by field.
Optional: group your checks result according to a custom tag key.
Display a custom title for your widget by activating the Show a Title
check box:
Optionally define its size and alignment.
This widget can be used with the Dashboards API. Refer to the Dashboards API documentation for additional reference.
The dedicated widget JSON schema definition for the check status widget is:
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": "string",
"tags": [],
"time": {
"live_span": "string"
},
"title": "string",
"title_align": "string",
"title_size": "string",
"type": "check_status"
}
Additional helpful documentation, links, and articles: