Widget Statut de check

Le widget Statut de check affiche le statut actuel ou le nombre de résultats associés à n’importe quel check réalisé :

Widget Statut de check

Configuration

Configuration du widget Statut de check

Configuration

  1. Sélectionnez un check de service précédemment créé.

  2. Choisissez un intervalle de transmission. Cet intervalle est toujours basé sur l’heure actuelle. Vous pouvez donc choisir une option comme The past 10 minutes (les 10 dernières minutes) ou The past 1 day (le dernier jour) pour afficher un statut pour cet intervalle. Si vous choisissez l’option Global Time, l’utilisateur du dashboard peut sélectionner une plage à l’aide du sélecteur temporel en haut à droite, mais celle-ci doit également être basée sur l’heure actuelle (par exemple, les X dernières heures ou les X derniers jours), sans quoi le widget n’affiche aucune donnée.

  3. Sélectionnez votre contexte :

    • A single check : sélectionnez cette option si votre widget Statut de check est dédié à un élément en particulier, par exemple host:<HOSTNAME> ou service:<NOM_SERVICE>.
    • A cluster of checks : sélectionnez cette option si votre widget Statut de check est dédié à un ensemble d’éléments, par exemple à l’ensemble des host ou des service.

  4. Terminez ensuite de définir le contexte de votre widget Statut de check en renseignant le champ Reported by.

  5. Facultatif : regroupez vos résultats de check en fonction d’une clé de tag personnalisée.

Options

Titre

Affichez un titre personnalisé pour votre widget en cochant la case Show a Title :

Titre du widget

Définissez sa taille et son alignement si vous le souhaitez.

API

Ce widget peut être utilisé avec l’API Dashboards. Consultez la documentation à ce sujet pour en savoir plus.

Le schéma JSON utilisé pour le widget Statut de check est le suivant :

Expand All

Champ

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

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

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,week_to_date,month_to_date,1y,alert

Option 2

object

Used for arbitrary live span times, such as 17 minutes or 6 hours.

type [required]

enum

Type "live" denotes a live span in the new format. Allowed enum values: live

unit [required]

enum

Unit of the time span. Allowed enum values: minute,hour,day,week,month,year

value [required]

int64

Value of the time span.

Option 3

object

Used for fixed span times, such as 'March 1 to March 7'.

from [required]

int64

Start time in seconds since epoch.

to [required]

int64

End time in seconds since epoch.

type [required]

enum

Type "fixed" denotes a fixed span. Allowed enum values: fixed

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

default: 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"
}

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Créer des dashboards avec JSONDOCUMENTATION more more