ヒートマップウィジェット

ヒートマップ可視化機能は、多数のタグ (hosts など) に対して集計されたメトリクスを表示します。特定の値を持つホストが多いほど、四角形の色が濃く表示されます。

この可視化機能は、1 つのメトリクスクエリのみを表示します。追加のクエリは無視されます。

注: この可視化で外れ値の検出を行うことはできません。

セットアップ

コンフィギュレーション

通常どおりにメトリクスクエリを構成します。この可視化タイプは、メトリクスが host ごとなどの複数のタグキーに対して集計される場合にのみ有用です。

avg/max/min/sum by のコントロールで選択を行い、関連付けられているタグのデータを表示します。

オプション

イベントオーバーレイ

関連するシステムからイベントを追加して、グラフにさらにコンテキストを追加できます。たとえば、GitHub のコミットイベント、Jenkins のデプロイイベント、Docker の作成イベントなどを追加できます。Event Overlays セクションを展開して、イベントを表示するためのクエリを入力します。イベントストリームと同じクエリ書式を使用してください。以下に例を示します。

クエリ	説明
`sources:jenkins`	Jenkins ソースから取得されたすべてのイベントを表示します。
`tag:role:web`	タグ `role:web` が付いたすべてのイベントを表示します。
`tags:$<TEMPLATE_VARIABLE>`	選択されたテンプレート変数から取得されたすべてのイベントを表示します。

Y 軸コントロール

Y 軸コントロールは、UI または JSON エディターから使用できます。以下を実行できます。

Y 軸を特定の範囲にクリップできます。
パーセンテージしきい値または絶対しきい値に基づいて Y 軸の境界を自動的に変更できます。このしきい値をグラフの両端 (下側と上側) の一方に適用することで、「外れ値」系列を除外できます。
Y 軸の目盛を線形から対数、累乗、または平方根に変更できます。

Y 軸の目盛を変更するには、Y-Axis Controls ボタンを展開します。

使用できる構成オプションは、次のとおりです。

オプション	必須	説明
`Min`/`Max`	いいえ	Y 軸に表示する最小値または最大値、またはその両方を指定します。数値または `Auto` (デフォルト値を使用) を指定します。
`Scale`	いいえ	目盛のタイプを指定します。使用可能な値: - linear: 線形目盛 (デフォルト) - log: 対数目盛 - pow: 2 の累乗目盛 (2 はデフォルトです。JSON で変更できます) - sqrt: 平方根目盛
`Always include zero`	いいえ	常に 0 を含めるか、軸をデータの範囲に合わせるかを指定します。デフォルトは、常に 0 を含めます。

注: 対数関数には負の値を適用できないため、Datadog の対数目盛は、値の符号がすべて同じ (すべて正またはすべて負) の場合にのみ機能します。そうでない場合は、空のグラフが返されます。

API

ヒートマップウィジェットのウィジェット JSON スキーマ定義は次のとおりです。

HEATMAP_SCHEMA = {
    "type": "object",
    "properties": {
        "type": {"enum": ["heatmap"]},
        "requests": {
            "type":     "array",
            "items":    REQUEST_SCHEMA,
            "minItems": 1,
            "maxItems": 1
        },
        "yaxis":  AXIS_SCHEMA,
        "events": EVENTS_SCHEMA,
        "title":   {"type": "string"},
        "show_legend": {"type": "boolean"}
    },
    "required": ["type", "requests"],
    "additionalProperties": false
}

パラメーター	種類	必須	説明
`type`	string	はい	ウィジェットのタイプ。ヒートマップウィジェットには `heatmap` を使用します。
`requests`	オブジェクトの配列	はい	ウィジェットに表示する 1 つの `request` オブジェクトの配列。`REQUEST_SCHEMA` の作成方法については、リクエスト JSON スキーマに関するドキュメントを参照してください。
`yaxis`	object	いいえ	Y 軸コントロールのオプション。`<AXIS_SCHEMA>` の作成方法については、Y 軸 JSON スキーマに関するドキュメントを参照してください。
`events`	object	いいえ	イベントオーバーレイコントロールのオプション。`<EVENTS_SCHEMA>` の作成方法については、イベント JSON スキーマに関するドキュメントを参照してください。
`title`	string	いいえ	ウィジェットのタイトル。
`show_legend`	boolean	いいえ	（スクリーンボードのみ）このウィジェットのレジェンドを表示

requests オブジェクトでは、以下のプロパティも使用できます。

{
  "style": {
    "type": "object",
    "properties": {"palette": {"type": "string"}},
    "additionalProperties": false
  }
}

パラメーター	種類	必須	説明
`style.palette`	string	いいえ	ウィジェットに適用するカラーパレット。

その他の参考資料

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

Timeboardsドキュメント

スクリーンボードドキュメント

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