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 timeframe:

• Global Time
• The past 10 minutes
• The past 30 minutes
• The past hour
• The past 4 hours
• The past day

3. Choose your scope:

   • A single check: Select this option if your Check Status widget is for a specific element only i.e. 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. Refer to 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": "string",
  "tags": [],
  "time": {
    "live_span": "string"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "check_status"
}

Further Reading

Additional helpful documentation, links, and articles:

ScreenboardDOCUMENTATION TimeboardsDOCUMENTATION Building Dashboard using JSONDOCUMENTATION