TiDB Cloudと Datadog の統合 (プレビュー)
TiDB CloudはDatadogとの連携(プレビュー)をサポートしています。TiDB TiDB Cloudを設定して、TiDBクラスターのメトリクスをデータドッグに送信できます。その後、これらのメトリクスをDatadogダッシュボードで直接確認できるようになります。
Datadog統合バージョン
TiDB Cloud は、 2022 年 3 月 4 日から Datadog 統合 (ベータ版) をサポートしています。2025 年 7 月 31 日から、 TiDB Cloud は統合の拡張プレビュー バージョンを導入します。
- Datadog 統合 (プレビュー) : 2025 年 7 月 31 日までに組織内に削除されていない Datadog または New Relic 統合がない場合、 TiDB Cloud は組織が最新の機能強化を体験できるように、Datadog 統合のプレビュー バージョンを提供します。
- Datadog 連携(ベータ版) :2025年7月31日までに組織内で Datadog または New Relic 連携が少なくとも1つ削除されていない場合、 TiDB Cloud は既存の連携と新規の連携の両方をベータ版で保持し、現在のダッシュボードへの影響を回避します。また、適切な移行プランとタイムラインについてご相談させていただきます。
前提条件
TiDB Cloudを Datadog と統合するには、Datadog アカウントとDatadog APIキー必要です。Datadog アカウントを初めて作成すると、Datadog から API キーが付与されます。
Datadog アカウントをお持ちでない場合は、 https://app.datadoghq.com/signupでサインアップしてください。
TiDB Cloudのサードパーティメトリクス統合を設定するには、 TiDB Cloudの
Organization Owner
またはProject Owner
アクセス権が必要です。統合ページを表示したり、提供されているリンクを介して設定済みのダッシュボードにアクセスしたりするには、 TiDB Cloudのプロジェクト内のターゲットクラスターにアクセスするためのProject Viewer
以上のロールが必要です。
制限
TiDB CloudスターターまたはTiDB Cloudエッセンシャルクラスターでは Datadog 統合を使用できません。
クラスターのステータスがCREATING 、 RESTORING 、 PAUSED 、またはRESUMINGの場合、Datadog 統合は使用できません。
Datadog 統合を備えたクラスターが削除されると、それに関連付けられている統合サービスも削除されます。
手順
ステップ1. Datadog APIキーとの統合
Datadog統合バージョンに応じて、統合ページにアクセスする手順は異なります。
TiDB Cloudコンソールで、プロジェクトのクラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
左側のナビゲーション ペインで、 [設定] > [統合]をクリックします。
[統合]ページで、 [Datadog への統合 (プレビュー)]をクリックします。
Datadog API キーを入力し、Datadog サイトを選択します。
[統合のテスト]をクリックします。
- テストが成功すると、 「確認」ボタンが表示されます。
- テストに失敗した場合はエラーメッセージが表示されます。メッセージに従ってトラブルシューティングを行い、統合を再試行してください。
「確認」をクリックして統合を完了します。
TiDB Cloudコンソールで、左上隅のコンボ ボックスを使用してターゲット プロジェクトに切り替えます。
左側のナビゲーション ペインで、 [プロジェクト設定] > [統合]をクリックします。
[統合]ページで、 [Datadog への統合 (ベータ版)]をクリックします。
Datadog API キーを入力し、Datadog サイトを選択します。
[統合のテスト]をクリックします。
- テストが成功すると、 「確認」ボタンが表示されます。
- テストに失敗した場合はエラーメッセージが表示されます。メッセージに従ってトラブルシューティングを行い、統合を再試行してください。
「確認」をクリックして統合を完了します。
ステップ2. DatadogにTiDB Cloud統合をインストールする
注記:
DatadogにTiDB Cloud統合を既にインストールしている場合は、このセクションの以下の手順をスキップできます。ダッシュボードTiDB Cloudダイナミック トラッカーまたはTiDB Cloudクラスタの概要 、Datadog ダッシュボードリストで自動的に利用可能になります。
データドッグにログインします。
Datadog のTiDB Cloud統合ページへ進みます。
[コンフィグレーション]タブで、 [統合のインストール]をクリックします。
- Datadog 統合 (プレビュー) の場合、 TiDB Cloudダイナミック トラッカーダッシュボードがダッシュボードリストに表示されます。
- Datadog 統合 (ベータ版) の場合、 TiDB Cloudクラスタの概要ダッシュボードがダッシュボードリストに表示されます。
あらかじめ構築されたダッシュボードをビュー
TiDB Cloudコンソールで、 「統合」ページに移動します。
Datadogセクションのダッシュボードリンクをクリックします。
- Datadog 統合 (プレビュー) の場合、ダッシュボードリンクをクリックすると、プレビュー バージョンで導入された最新のメトリックを含む新しいダッシュボードが開きます。
- Datadog 統合 (ベータ版) の場合、ダッシュボードリンクをクリックすると、プレビュー バージョンで導入された最新のメトリックが含まれない従来のダッシュボードが開きます。
Datadogで利用可能なメトリクス
Datadog は、TiDB クラスターの次のメトリクスを追跡します。
メトリック名 | メトリックタイプ | ラベル | 説明 |
---|---|---|---|
tidb_cloud.db_database_time | ゲージ | sql_type: 選択 | 挿入 |
tidb_cloud.db_query_per_second | ゲージ | タイプ: 選択 | 挿入 |
tidbcloud.db平均クエリ実行時間 | ゲージ | sql_type: 選択 | 挿入 |
tidb_cloud.db_failed_queries | ゲージ | タイプ: executor:xxxx | parser:xxxx |
tidb_cloud.db_total_connection | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… コンポーネント: tidb |
tidb_cloud.db_active_connections | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… コンポーネント: tidb |
tidb_cloud.db_disconnections | ゲージ | 結果: OK | エラー |
tidb_cloud.db_command_per_second | ゲージ | タイプ: Query | StmtPrepare |
tidb_cloud.db_queries_using_plan_cache_ops | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… コンポーネント: tidb |
tidb_cloud.db_transaction_per_second | ゲージ | txn_mode:悲観的 | 楽観的 タイプ: 中止 |
tidb_cloud.node_storage_used_bytes | ゲージ | クラスター名: <cluster name> インスタンス: tikv-0 | tikv-1… |
tidb_cloud.node_storage_capacity_bytes | ゲージ | クラスター名: <cluster name> インスタンス: tikv-0 | tikv-1… |
tidb_cloud.node_cpu_seconds_total | カウント | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… |
tidb_cloud.node_cpu_capacity_cores | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… |
tidb_cloud.node_memory_used_bytes | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… |
tidb_cloud.node_memory_capacity_bytes | ゲージ | クラスター名: <cluster name> インスタンス: tidb-0 | tidb-1… |
Datadog 統合 (プレビュー) では、次の追加メトリックも利用できます。
メトリック名 | メトリックタイプ | ラベル | 説明 |
---|---|---|---|
tidbcloud.node_storage_available_bytes | ゲージ | インスタンス: tidb-0\|tidb-1\|... コンポーネント: tikv\|tiflash クラスター名: <cluster name> | TiKV/ TiFlashノードで使用可能なディスク容量 (バイト単位)。 |
tidbcloud.ディスク読み取りレイテンシー | ゲージ | インスタンス: tidb-0\|tidb-1\|... コンポーネント: tikv\|tiflash クラスター名: <cluster name> device 時nvme.*\|dm.* | storageデバイスあたりの読み取りレイテンシー(秒)。 |
tidbcloud.disk_write_latency | ゲージ | インスタンス: tidb-0\|tidb-1\|... コンポーネント: tikv\|tiflash クラスター名: <cluster name> device 時nvme.*\|dm.* | storageデバイスあたりの書き込みレイテンシー(秒単位)。 |
tidbcloud.kv_request_duration | ヒストグラム | インスタンス: tidb-0\|tidb-1\|... コンポーネント: tikv クラスター名: <cluster name> type 時BatchGet\|Commit\|Prewrite\|... | タイプ別の TiKV リクエストの継続時間(秒)。 |
tidbcloud.コンポーネントの稼働時間 | ゲージ | インスタンス: tidb-0\|tidb-1\|... コンポーネント: tidb\|tikv\|tiflash クラスター名: <cluster name> | TiDB コンポーネントの稼働時間 (秒単位)。 |
tidbcloud.ticdc_owner_checkpoint_ts_lag | ゲージ | チェンジフィードID: <changefeed-id> クラスター名: <cluster name> | 変更フィード所有者のチェックポイント タイムスタンプの遅延 (秒単位)。 |
tidbcloud.ticdc_owner_resolved_ts_lag | ゲージ | チェンジフィードID: <changefeed-id> クラスター名: <cluster name> | 変更フィード所有者の解決されたタイムスタンプの遅延 (秒単位)。 |
tidbcloud.changefeed_status | ゲージ | チェンジフィードID: <changefeed-id> クラスター名: <cluster name> | チェンジフィードステータス:-1 :不明0 :正常1 : 警告2 : 失敗3 : 停止4 :終了6 :警告7 : その他 |
tidbcloud.resource_manager_resource_unit_read_request_unit | ゲージ | クラスター名: <cluster name> リソースグループ: <group-name> | リソース マネージャーによって消費される読み取り要求単位 (RU)。 |
tidbcloud.resource_manager_resource_unit_write_request_unit | ゲージ | クラスター名: <cluster name> リソースグループ: <group-name> | リソース マネージャーによって消費される書き込み要求単位 (RU)。 |
tidb_cloud.dm_task_state | ゲージ | インスタンス: instance タスク: task クラスター名: <cluster name> | データ移行のタスクの状態: 0: 無効 1: 新しい 2: ランニング 3: 一時停止 4: 停止 5: 完了 15: エラー |
tidb_cloud.dm_syncer_replication_lag_bucket | ゲージ | インスタンス: instance クラスター名: <cluster name> | データ移行の遅延 (バケット) を複製します。 |
tidb_cloud.dm_syncer_replication_lag_gauge | ゲージ | インスタンス: instance タスク: task クラスター名: <cluster name> | データ移行の遅延 (ゲージ) を複製します。 |
tidb_cloud.dm_relay_read_error_count | ゲージ | インスタンス: instance クラスター名: <cluster name> | マスターからのbinlogの読み取りに失敗しました。 |