JSON を使用したグラフ作成

ダッシュボード API を使用して Datadog タイムボードをクエリすると、結果は、以下のレイアウトの JSON オブジェクトになります。

DASHBOARD_SCHEMA = {
    "type": "object",
    "properties": {
        "title": {"type": "string"},
        "description": {"type": "string"},
        "layout_type": {"enum": ["ordered", "free"]},
        "is_read_only": {"type": "boolean"},
        "template_variables": {"type": "array", "items": TEMPLATE_VARIABLE_SCHEMA},
        "notify_list": {"type": "array", "items": {"type": "string"}},
        "widgets": {
            "type": "array",
            "items": WIDGET_SCHEMA
        }
    },
    "required": ["title", "layout_type", "widgets"],
}
パラメーター種類説明
titlestringダッシュボードのタイトル。
descriptionstringダッシュボードの説明。
layout_typeenumダッシュボードのレイアウトタイプ。使用可能な値: ordered または free
is_read_onlyBooleanこのダッシュボードを読み取り専用にするかどうかを指定します。true の場合、ダッシュボードの作成者とアクセス管理 (user_access_manage) 権限を持つユーザーのみが変更できます。
template_variablesオブジェクトの配列このダッシュボードのテンプレート変数のリスト。詳細は、テンプレート変数スキーマをご参照ください。
notify_list文字列の配列このダッシュボードに変更が加えられたときに通知するユーザーのハンドルのリスト。
widgetsオブジェクトの配列ダッシュボードに表示するウィジェットのリスト。WIDGET_SCHEMA の作成については、別途ドキュメントをご用意しています。ウィジェットの JSON スキーマガイドをご参照ください。

テンプレート変数スキーマ

ダッシュボードテンプレート変数は、ダッシュボード上の 1 つ以上のグラフに新しいスコープを適用します。これにより、特定のタグではなく変数を使用することで、複数のタグセットにまたがってメトリクスを動的に調査することができます。ダッシュボード API で変数を設定するには、以下のレイアウトを使用します。

TEMPLATE_VARIABLE_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "default": {"type": "string"},
        "prefix": {"type": "string"},
    },
    "additionalProperties": false,
    "required": ["name"]
}
パラメーター種類説明
namestringテンプレート変数の名前。
defaultstringテンプレート変数のデフォルト値。
prefixstringテンプレート変数のタグキー。

Datadog UI でテンプレート変数を使用する方法については、こちらを参照してください

その他の参考資料