チェックステータスウィジェット

チェックステータスウィジェット

チェックステータスは、実行されたチェックの現在のステータスまたは結果の数を表示します。

セットアップ

コンフィギュレーション

  1. これまでに作成したサービスチェックの 1 つを選択します。
  2. 報告対象のタイムフレームを選択します。
  • グローバルタイム
  • 過去 10 分間
  • 過去 30 分間
  • 過去 1 時間
  • 過去 4 時間
  • 過去 1 日
  1. スコープを選択します。

    • A single check: チェックステータスウィジェットが特定の要素 (1 つの host:<HOSTNAME>、1 つの service:<SERVICE_NAME> など) のみを対象とする場合は、このオプションを選択します。
    • A cluster of checks: チェックステータスウィジェットが一定の範囲の要素 (すべての host、すべての service など) を対象とする場合は、このオプションを選択します。
  2. スコープを選択したら、Reported by フィールドで、チェックステータスウィジェットのコンテキストを定義します。

  3. オプション: チェック結果をカスタムタグキーによってグループ化します。

オプション

タイトル

Show a Title チェックボックスをオンにして、ウィジェットのカスタムタイトルを表示します。

オプションで、サイズと配置を定義できます。

API

このウィジェットは、ダッシュボード API とともに使用できます。詳しくは、ダッシュボード API ドキュメントをご参照ください。

チェックステータスウィジェット専用のウィジェット JSON スキーマ定義は次のとおりです。

Expand All

フィールド

種類

説明

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

その他の参考資料