テレメトリー

テレメトリを有効にすると、TiDB、 TiUP 、および TiDB ダッシュボードは使用状況情報を収集し、その情報を PingCAP と共有して、製品の改善方法の理解に役立てます。たとえば、この使用状況情報は、新機能の優先順位付けに役立ちます。

注記：

• 2023 年 2 月 20 日以降、v6.6.0 を含む TiDB および TiDB Dashboard の新しいバージョンでは、テレメトリ機能がデフォルトで無効になっており、使用状況情報は収集されず、PingCAP と共有されません。これらのバージョンにアップグレードする前に、クラスターがデフォルトのテレメトリ構成を使用している場合、アップグレード後にテレメトリ機能が無効になります。特定のバージョンについては、 TiDB リリース タイムライン参照してください。
• v1.11.3 以降、新しく導入されたTiUPではテレメトリ機能がデフォルトで無効になっており、使用状況情報は収集されません。v1.11.3 より前のバージョンのTiUPから v1.11.3 以降のバージョンにアップグレードした場合、テレメトリ機能はアップグレード前と同じ状態を維持します。

共有されるものは何ですか?

以下のセクションでは、各コンポーネントの共有される使用情報について詳しく説明します。共有される使用詳細は、時間の経過とともに変更される可能性があります。これらの変更 (ある場合) はリリースノートで発表されます。

注記：

いずれの場合も、TiDB クラスターに保存されているユーザー データは共有されません。5 PingCAP プライバシーポリシー参照してください。

ティビ

TiDB でテレメトリ収集機能が有効になっている場合、TiDB クラスターは 6 時間ごとに使用状況の詳細を収集します。これらの使用状況の詳細には、次のものが含まれますが、これらに限定されません。

• ランダムに生成されたテレメトリ ID。
• ハードウェア (CPU、メモリ、ディスク) のサイズ、TiDB コンポーネントのバージョン、OS 名などのデプロイメント特性。
• クエリ要求の数や期間など、システム内のクエリ要求のステータス。
• コンポーネントの使用状況。たとえば、非同期コミット機能が使用されているかどうかなど。
• TiDB テレメトリ データ送信者の仮名 IP アドレス。

PingCAP に共有された使用状況情報の全内容を表示するには、次の SQL ステートメントを実行します。

ADMIN SHOW TELEMETRY;

TiDBダッシュボード

TiDB ダッシュボードのテレメトリ収集機能が有効になっている場合、次のような (ただしこれらに限定されない) TiDB ダッシュボード Web UI の使用状況の詳細が共有されます。

• ランダムに生成されたテレメトリ ID。
• ユーザーがアクセスした TiDB ダッシュボード Web ページの名前などのユーザー操作情報。
• ブラウザ名、OS 名、画面解像度などのブラウザと OS の情報。

PingCAP に共有された使用情報の全内容を表示するには、 Chrome DevTools のネットワーク アクティビティ インスペクターまたはFirefox 開発ツールのネットワーク モニター使用します。

TiUP

TiUPでテレメトリ収集機能が有効になっている場合、次のようなTiUPの使用状況の詳細が共有されます (ただし、これらに限定されません)。

• ランダムに生成されたテレメトリ ID。
• 実行が成功したかどうかや実行時間などのTiUPコマンドの実行ステータス。
• ハードウェアのサイズ、TiDB コンポーネントのバージョン、変更されたデプロイメント構成名などのデプロイメント特性。

PingCAP に共有された使用情報の全内容を表示するには、 TiUPコマンドを実行するときにTIUP_CLUSTER_DEBUG=enable環境変数を設定します。例:

TIUP_CLUSTER_DEBUG=enable tiup cluster list

ティスパーク

注記：

v3.0.3 以降、TiSpark ではテレメトリ収集がデフォルトで無効になっており、使用状況情報は収集されず、PingCAP と共有されません。

TiSpark のテレメトリ収集機能が有効になっている場合、Spark モジュールは TiSpark の使用状況の詳細 (以下を含むがこれらに限定されない) を共有します。

• ランダムに生成されたテレメトリ ID。
• 読み取りエンジンやストリーミング読み取りが有効かどうかなど、TiSpark の一部の構成情報。
• TiSpark が配置されているノードのマシン ハードウェア情報、OS 情報、コンポーネントバージョン番号などのクラスタ展開情報。

Spark ログに収集された TiSpark の使用状況情報を表示できます。Spark ログ レベルを INFO 以下に設定できます。例:

cat {spark.log} | grep Telemetry report | tail -n 1

テレメトリを無効にする

デプロイメント時に TiDB テレメトリを無効にする

既存の TiDB クラスターでテレメトリが有効になっている場合は、各 TiDB インスタンスでenable-telemetry = false構成して、そのインスタンスでの TiDB テレメトリ収集を無効にすることができます。これは、クラスターを再起動するまで有効になりません。

さまざまな展開ツールでテレメトリを無効にする詳細な手順を以下に示します。

enable-telemetry = false

enable-telemetry = false

tiup playground --db.config tidb_config.toml

server_configs:
  tidb:
    enable-telemetry: false

デプロイされた TiDB クラスターの TiDB テレメトリを無効にする

既存の TiDB クラスターでは、システム変数tidb_enable_telemetryを変更して、TiDB テレメトリ収集を動的に無効にすることもできます。

SET GLOBAL tidb_enable_telemetry = 0;

注記：

テレメトリを無効にすると、構成ファイルはシステム変数よりも優先されます。つまり、構成ファイルによってテレメトリの収集が無効にされると、システム変数の値は無視されます。

TiDBダッシュボードテレメトリを無効にする

すべての PD インスタンスで TiDB ダッシュボード テレメトリ収集を無効にするには、 dashboard.enable-telemetry = false設定します。設定を有効にするには、実行中のクラスターを再起動する必要があります。

さまざまな展開ツールのテレメトリを無効にする詳細な手順を以下に示します。

[dashboard]
enable-telemetry = false

[dashboard]
enable-telemetry = false

tiup playground --pd.config pd_config.toml

server_configs:
  pd:
    dashboard.enable-telemetry: false

TiUPテレメトリを無効にする

TiUPテレメトリ収集を無効にするには、次のコマンドを実行します。

tiup telemetry disable

テレメトリステータスを確認する

TiDB テレメトリの場合、次の SQL ステートメントを実行してテレメトリのステータスを確認します。

ADMIN SHOW TELEMETRY;

実行結果のDATA_PREVIEW列目が空の場合、TiDB テレメトリは無効です。空でない場合は、TiDB テレメトリが有効です。また、 LAST_STATUS列目から、以前に使用状況情報が共有された時期や、共有が成功したかどうかも確認できます。

TiUPテレメトリの場合、次のコマンドを実行してテレメトリのステータスを確認します。

tiup telemetry status

コンプライアンス

さまざまな国や地域のコンプライアンス要件を満たすために、使用情報は送信側マシンの IP アドレスに応じてさまざまな国にあるサーバーに送信されます。

• 中国本土の IP アドレスの場合、使用情報は中国本土のクラウド サーバーに送信され、保存されます。
• 中国本土以外の IP アドレスの場合、使用情報は米国のクラウド サーバーに送信され、保存されます。

詳細はPingCAP プライバシーポリシー参照。