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 is 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>.
   • A cluster of checks: Select this option if your Check Status widget is for a scope of elements as in all hosts, or all services.

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:

{
  "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

Additional helpful documentation, links, and articles:

Building Dashboards using JSONDOCUMENTATION