- 重要な情報
- はじめに
- 用語集
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
ダッシュボード 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"],
}
パラメーター | 種類 | 説明 |
---|---|---|
title | string | ダッシュボードのタイトル。 |
description | string | ダッシュボードの説明。 |
layout_type | enum | ダッシュボードのレイアウトタイプ。使用可能な値: ordered または free |
is_read_only | Boolean | このダッシュボードを読み取り専用にするかどうかを指定します。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"]
}
パラメーター | 種類 | 説明 |
---|---|---|
name | string | テンプレート変数の名前。 |
default | string | テンプレート変数のデフォルト値。 |
prefix | string | テンプレート変数のタグキー。 |
Datadog UI でテンプレート変数を使用する方法については、こちらを参照してください。
お役に立つドキュメント、リンクや記事: