Skip to content

Latest commit

 

History

History
186 lines (125 loc) · 30.1 KB

File metadata and controls

186 lines (125 loc) · 30.1 KB
title Integrate TiDB Cloud with New Relic
summary New Relicとの連携により、TiDBクラスターを監視する方法を学びましょう。

TiDB CloudとNew Relicを統合する {#integrate-tidb-cloud-with-new-relic}

TiDB CloudはNew Relicとの連携をサポートしています。TiDB Cloudを設定して、TiDBクラスターのメトリクスをニューレリックに送信することができます。その後、New Relicダッシュボードでこれらのメトリクスを直接確認できます。

新しいRelic統合バージョン {#new-relic-integration-version}

TiDB Cloudは、2023年4月11日よりプロジェクトレベルのNew Relic統合(ベータ版)をサポートしてきました。2025年7月31日より、TiDB CloudレベルのNew Relic統合(プレビュー版)を導入します。2025年9月30日より、クラスターレベルのNew Relic統合が一般提供(GA)となります。

  • クラスターレベルのNew Relic統合:2025年7月31日までに組織内で削除されていない従来のプロジェクトレベルのDatadogまたはNew Relic統合が残っていない場合、 TiDB Cloudは組織が最新の機能強化を体験できるように、クラスターレベルのNew Relic統合を提供します。
  • 従来のプロジェクトレベルの New Relic 統合 (ベータ版) : 2025 年 7 月 31 日時点で組織内に少なくとも 1 つの従来のプロジェクトレベルの Datadog または New Relic 統合が削除されずに残っている場合、 TiDB Cloud は、現在のダッシュボードへの影響を回避するために、組織向けにプロジェクトレベルで既存および新規の統合の両方を保持します。従来のプロジェクトレベルの New Relic 統合は、2025 年 10 月 31 日に廃止されることに注意してください。組織がこれらの従来の統合をまだ使用している場合は、DatadogとNew Relicの統合を移行する手順に従って、新しいクラスターレベルの統合に移行し、メトリクス関連サービスへの影響を最小限に抑えてください。

前提条件 {#prerequisites}

  • TiDB Cloud をNew Relic と統合するには、ニューレリックレリック アカウントと、 Ingest - LicenseタイプのNew Relic APIキーを作成する必要があります。

    New Relicのアカウントをお持ちでない場合は、ここご登録ください。

  • TiDB Cloudのサードパーティ メトリクス統合を設定するには、 TiDB CloudでOrganization OwnerまたはProject Ownerアクセス権が必要です。統合ページを表示したり、提供されたリンクから設定済みのダッシュボードにアクセスしたりするには、TiDB Cloudのプロジェクト内の対象のTiDB Cloud DedicatedクラスターにアクセスするためのProject Viewerロール以上が必要です。

制限 {#limitation}

  • New Relicとの連携機能は、現在TiDB Cloud Dedicatedクラスターでのみ利用可能です。

  • クラスターの状態が**「作成中」** 、 「復元中」「一時停止中」 、 **「再開中」**の場合は、New Relic の統合は利用できません。

  • New Relicとの連携が確立されたクラスターが削除されると、それに関連付けられた連携サービスも削除されます。

手順 {#steps}

ステップ1. New Relic APIキーと連携する {#step-1-integrate-with-your-new-relic-api-key}

新しいRelic統合バージョンに応じて、統合ページにアクセスする手順は異なります。

  1. TiDB Cloudコンソールで、私のTiDBページに移動し、ターゲットのTiDB Cloud Dedicatedクラスターの名前をクリックして、その概要ページに移動します。

  2. 左側のナビゲーションペインで、 [設定] > **[統合]**をクリックします。

  3. 統合ページで、 **「New Relic との統合」**をクリックします。

  4. New RelicのAPIキーを入力し、New Relicのサイトを選択してください。

  5. **「統合テスト」**をクリックします。

    • テストが成功すると、 **「確認」**ボタンが表示されます。
    • テストが失敗した場合は、エラーメッセージが表示されます。メッセージに従ってトラブルシューティングを行い、統合を再試行してください。
  6. 統合を完了するには、 **「確認」**をクリックしてください。

  1. TiDB Cloudコンソールで、組織の私のTiDBページに移動し、 **[プロジェクト ビュー]**タブをクリックします。

  2. プロジェクトビューで、対象のプロジェクトを見つけて、そのプロジェクトのをクリックします。

  3. 左側のナビゲーションペインで、 **「プロジェクト設定」の下にある「統合」**をクリックします。

  4. 統合ページで、 **[New Relic との統合 (ベータ版)]**をクリックします。

  5. New RelicのAPIキーを入力し、New Relicのサイトを選択してください。

  6. **「統合テスト」**をクリックします。

    • テストが成功すると、 **「確認」**ボタンが表示されます。
    • テストが失敗した場合は、エラーメッセージが表示されます。メッセージに従ってトラブルシューティングを行い、統合を再試行してください。
  7. 統合を完了するには、 **「確認」**をクリックしてください。

ステップ2. New RelicにTiDB Cloudダッシュボードを追加する {#step-2-add-tidb-cloud-dashboard-in-new-relic}

新しいRelic統合バージョンに応じて、手順は異なります。

新しいTiDB Cloudダッシュボードは、保留中の広報New Relicによってマージされた後にNew Relicで利用可能になります。それまでは、以下の手順でダッシュボードをNew Relicに手動でインポートできます。

  1. 新しいダッシュボード用のJSONファイルを準備します。

    1. テンプレートの JSON ファイルをここダウンロードします。

    2. JSONファイルで、4行目に"permissions": "PUBLIC_READ_WRITE"以下のように追加します。

      {
        "name": "TiDB Cloud Dynamic Tracker",
        "description": null,
        "permissions": "PUBLIC_READ_WRITE",
        ...
      }
    3. JSON ファイル内のすべての"accountIds": []フィールドに New Relic アカウント ID を追加してください。

      例えば:

      "accountIds": [
        1234567
      ],

      注記

      統合エラーを回避するために、JSON ファイル内のすべての"accountIds"フィールドにアカウント ID が追加されていることを確認してください。

  2. ニューレリックにログインし、左側のナビゲーションバーの**「ダッシュボード」をクリックし、右上隅の「ダッシュボードのインポート」**をクリックします。

  3. 表示されたダイアログで、準備した JSON ファイルの内容をすべてテキスト エリアに貼り付け、次に**[ダッシュボードをインポート] を**クリックします。

  1. ニューレリックにログインします。
  2. **「データの追加」**をクリックし、 TiDB Cloudを検索して、 TiDB Cloud監視ページに移動します。または、 リンククリックして直接ページにアクセスすることもできます。
  3. アカウントIDを選択し、New Relicでダッシュボードを作成してください。

事前に構築されたダッシュボードをビュー {#view-the-pre-built-dashboard}

  1. TiDB Cloudコンソールで、 **「統合」**ページに移動します。

  2. New Relicセクションの**「ダッシュボード」**リンクをクリックすると、TiDBクラスターの事前構築済みダッシュボードが表示されます。

  3. 新しいRelic統合バージョンに応じて、次のいずれかを実行します。

    • クラスターレベルでのNew Relic統合を行うには、 TiDB Cloud Dynamic Trackerをクリックして新しいダッシュボードを表示してください。
    • 従来のプロジェクトレベルのNew Relic統合(ベータ版)については、 **「TiDB Cloud Monitoring」**をクリックして従来のダッシュボードを表示してください。

New Relicで利用可能なメトリクス {#metrics-available-to-new-relic}

New Relicは、TiDBクラスターに関して以下のメトリクスを追跡します。

メトリック名 メトリックタイプ ラベル 説明
tidb_cloud.db_database_time ゲージ sql_type: Select Insert
tidb_cloud.db_query_per_second ゲージ タイプ: 選択 挿入
tidb_cloud.db_average_query_duration ゲージ sql_type: Select Insert
tidb_cloud.db_failed_queries ゲージ タイプ: 実行者:xxxx パーサー: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|エラー|不明

クラスター名: <cluster name>

インスタンス: tidb-0
tidb-1…

コンポーネント: tidb
tidb_cloud.db_command_per_second ゲージ タイプ: クエリ ステートメント準備
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_ストレージ_used_bytes ゲージ クラスター名: <cluster name>

インスタンス: tikv-0
tikv-1…
tidb_cloud.node_ストレージ_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…

クラスターレベルのNew Relic統合では、以下の追加メトリクスも利用可能です。

メトリック名 メトリックタイプ ラベル 説明
tidb_cloud.node_ストレージ_available_bytes ゲージ インスタンス: tidb-0|tidb-1|...

コンポーネント: tikv|tiflash

クラスター名: <cluster name>
TiKVまたはTiFlashノードで使用可能なディスク容量(バイト単位)。
tidb_cloud.node_disk_read_latency ゲージ インスタンス: tidb-0|tidb-1|...

コンポーネント: tikv|tiflash

クラスター名: <cluster name>

device : nvme.*|dm.*
ストレージデバイスごとの読み取りレイテンシー(秒単位)。
tidb_cloud.node_disk_write_latency ゲージ インスタンス: tidb-0|tidb-1|...

コンポーネント: tikv|tiflash

クラスター名: <cluster name>

device : nvme.*|dm.*
ストレージデバイスごとの書き込みレイテンシー(秒単位)。
tidb_cloud.db_kv_request_duration ゲージ インスタンス: tidb-0|tidb-1|...

コンポーネント: tikv

クラスター名: <cluster name>

type : BatchGet|Commit|Prewrite|...
TiKVリクエストの種類別の所要時間(秒)。
tidb_cloud.db_component_uptime ゲージ インスタンス: tidb-0|tidb-1|...

コンポーネント: tidb|tikv|tiflash

クラスター名: <cluster name>
TiDBコンポーネントの稼働時間(秒単位)。
tidb_cloud.cdc_changefeed_latency (別名 cdc_changefeed_checkpoint_ts_lag) ゲージ changefeed_id: <changefeed-id>

クラスター名: <cluster name>
変更フィード所有者のチェックポイントタイムスタンプの遅延(秒単位)。
tidb_cloud.cdc_changefeed_resolved_ts_lag ゲージ changefeed_id: <changefeed-id>

クラスター名: <cluster name>
変更フィード所有者の解決済みタイムスタンプ遅延(秒単位)。
tidb_cloud.cdc_changefeed_status ゲージ changefeed_id: <changefeed-id>

クラスター名: <cluster name>
変更フィードのステータス:

-1 : 不明

0 : 通常

1 : 警告

2 : 失敗

3 : 停止しました

4 : 完了

6 : 警告

7 : その他
tidb_cloud.resource_manager_resource_unit_read_request_unit ゲージ クラスター名: <cluster name>

リソースグループ: <group-name>
リソースマネージャによって消費された読み取りリクエストユニット(RU)。
tidb_cloud.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の読み取りに失敗しました。
tidb_cloud.node_memory_available_bytes ゲージ クラスター名: <cluster name>

インスタンス: tidb-0
tidb-1…
tidb_cloud.cdc_changefeed_replica_rows ゲージ changefeed_id: <changefeed-id>

クラスター名: <cluster name>
TiCDCノードが1秒あたりにダウンストリームに書き込むイベントの数。
tidb_cloud.node_cpu_seconds_total_rate ゲージ クラスター名: <cluster name>

インスタンス: tidb-0
tidb-1…