モニターサマリーウィジェット

モニターサマリーウィジェットは、Datadog のすべてのモニターまたはクエリに基づく一部のモニターの概要を表示します。

モニターサマリー

セットアップ

Monitor サマリーの設定

コンフィギュレーション

  1. 3 つのサマリータイプ Monitor、Group、Combined のいずれかを選択します。

    • Monitor サマリータイプには、モニタークエリに一致するモニターのステータスと名前が一覧表示されます。マルチアラートモニターの結果リストには 1 行しかなく、そのステータスはマルチアラートモニターの全体的なステータスです。ステータスカウントは、各ステータスタイプと一致するモニターの数です。
    Monitor サマリータイプ
    • Group サマリータイプには、モニタークエリに一致するモニターのステータス、名前、グループが一覧表示されます。マルチアラートモニターは結果リストで複数行に分割され、各グループとマルチアラートモニター内のそのグループの特定のステータスに対応します。また、Group サマリータイプは、Triggered Monitors ページと同様に、モニタークエリで group と group_status ファセットをサポートしています。ステータスカウントは、各ステータスタイプと一致するモニターグループの数です。
    Group サマリータイプ
    • Combined サマリータイプには、モニタークエリに一致するグループステータスの数とモニターの名前が一覧表示されます。マルチアラートモニターの結果リストには、Monitor サマリータイプのように 1 行しかありませんが、グループ列には、モニターの全体的なステータスではなく、各ステータスタイプのグループ数が表示されます。また Group サマリータイプと同様に、Combined サマリータイプは、モニタークエリで group と group_status ファセットをサポートしています。ステータスカウントには、やはり Monitor サマリータイプのように、全体的なモニターステータスのカウントが表示されます。
    Combined サマリータイプ

  2. 一部のモニターを対象としてモニターサマリーウィジェットを表示する場合は、モニタークエリを入力します。

    注 上記のリンクにリストされたファセットに加えて、Group と Combined サマリータイプは、Triggered Monitors ページと同様に、グループレベルの検索用に group と group_status ファセットもサポートします。

テンプレート変数

ダッシュボードで作成したテンプレート変数をモニターサマリーの検索クエリで使用するには、Manage Monitor ページと同じクエリ形式に従ってください。

例

  1. テンプレート変数 $service を使って、モニター scope でフィルタリングを行う。

    管理ページやトリガーされたモニターページで scope を利用するには、scope:service:web-store を実行する必要があります。 したがって、ウィジェットで scope:$service を実行し、テンプレート変数の値をウィジェットに適用する必要があります。

    テンプレート変数のスコープ

  2. テンプレート変数 $env を使って、モニター group でフィルタリングを行う。

    管理ページやトリガーされたモニターページで group を利用するには、group:env:prod を実行する必要があります。 したがって、ウィジェットで group:$env を実行し、テンプレート変数の値をウィジェットに適用する必要があります。

    テンプレート変数のグループ化

オプション

表示設定

モニターステータスタイプごとのモニターの Count のみ、モニターの List、または Both のどれを表示するかを選択します。Text と Background オプションは、ステータスカウントのテキストまたは背景にステータスの色を適用するかどうかを指定します。Hide empty Status Counts オプションを有効にすると、結果リストにモニターがゼロより多いステータスのステータスカウントのみが表示されます。

表示設定

Show triggered column オプションを選択すると、トリガーされた状態（Alert、Warn、または No Data）のモニターまたはモニターグループに結果がフィルターされ、最近トリガーされたものから順にソートされます。モニター/グループが最後にトリガーされてから経過した時間を示す列が追加されます。

表示設定

タイトル

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

ウィジェットのタイトル

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

API

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

モニターサマリーウィジェットのウィジェット JSON スキーマ定義は次のとおりです。

Expand All

フィールド

種類

説明

color_preference

enum

Which color to use on the widget. Allowed enum values: background,text

count

int64

DEPRECATED: The number of monitors to display.

display_format

enum

What to display on the widget. Allowed enum values: counts,countsAndList,list

hide_zero_counts

boolean

Whether to show counts of 0 or not.

query [required]

string

Query to filter the monitors with.

show_last_triggered

boolean

Whether to show the time that has elapsed since the monitor/group triggered.

show_priority

boolean

Whether to show the priorities column.

sort

enum

Widget sorting methods. Allowed enum values: name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc,status,desc,tags,asc,tags,desc,triggered,asc,triggered,desc,priority,asc,priority,desc

start

int64

DEPRECATED: The start of the list. Typically 0.

summary_type

enum

Which summary type should be used. Allowed enum values: monitors,groups,combined

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 monitor summary widget. Allowed enum values: manage_status

{
  "color_preference": "string",
  "count": "integer",
  "display_format": "string",
  "hide_zero_counts": false,
  "query": "",
  "show_last_triggered": false,
  "show_priority": false,
  "sort": "name,asc",
  "start": "integer",
  "summary_type": "string",
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "manage_status"
}

その他の参考資料

お役に立つドキュメント、リンクや記事:

JSON を使用したダッシュボードの構築ドキュメント more more