Confluent Telemetry Reporter¶

Confluent Telemetry Reporter は、サービスに関するメタデータを Confluent にプッシュするために各 Confluent Platform サービス内で動作するプラグインです。Telemetry Reporter により、メタデータに基づく製品機能（Health+ など）が有効になります。データは HTTP を介して送信され、暗号化された接続が使用されます。

利用可能なメトリクスのリストについては、「Telemetry Reporter のメトリクス」を参照してください。

重要

クラスターで Self-Balancing が有効になっていると、Telemetry Reporter が有効になり、Self-Balancing Clusters の要件としてデフォルトで実行されます。Self-Balancing アルゴリズムでは、Telemetry Reporter の内部トピック _confluent-telemetry-metrics から消費が行われます。
クラスターで Self-Balancing が有効になっていない場合、$CONFLUENT_HOME/etc/kafka/server.properties のサーバー構成ファイルでプロパティ設定 confluent.reporters.telemetry.auto.enable=false を使用して、Telemetry Reporter を完全に無効にすることができます。
confluent.telemetry.enabled を false に設定した場合、データは Confluent Cloud に送信されません。

インストール¶

Confluent Telemetry Reporter は、Confluent Platform のフルインストールの一部としてインストールされます。パッケージを個別にインストールする場合は、yum install confluent-telemetry、またはご使用の環境で同等のパッケージマネージャーコマンドを使用して、Telemetry Reporter が確実にインストールされるようにします。

Confluent Cloud に対するテレメトリレポートの有効化¶

前提条件

Confluent Health+ へのサインアップ
インターネット接続（直接またはプロキシ経由）
Confluent Platform 6.0 以降

Cloud API キーおよびシークレットの作成¶

以下の手順によって、Confluent Cloud で認証するための API キーおよびシークレットを有効にします。

Cloud API キーは、Kafka クラスターの API キーとは異なります。Telemetry Reporter では、Kafka クラスターの API キーではなく、Cloud API キーを使用する必要があります。クラスターキーを使用すると認証エラーが発生します。

confluent api-key create コマンドを使用して、Cloud API キーを作成します。

confluent login
confluent api-key create --resource cloud

API キーの準備ができるまでには数分かかることがあります。API キーとシークレットを保存します。このシークレットを後から取得することはできません。出力は以下のようになります。

+---------+------------------------------------------------------------------+
| API Key | UZ7UB0BEMH7ZZL4T                                                 |
| Secret  | PcFU4EUD0bbSFaz3jnx2jhYmcuPVZShdowwhOkrYUhusFONqQtfU0tMtT8gkZSde |
+---------+------------------------------------------------------------------+

Health+ の構成¶

Health+ を構成する方法は多数あります。

Confluent Health+ へのサインアップがまだの場合はサインアップします。
ブラウザーで Confluent Control Center を開きます。デフォルト URL は http://localhost:9021/ です。
Home ページで、クラスターをクリックします。
ナビゲーションメニューで Health+ をクリックして概要ページを開きます。
Get started をクリックして、クラスターの Health+ をセットアップします。
Enable your cluster to communicate with Health+ セクションに、API キーとシークレットを入力します。
- Confluent CLI を使用してキーとシークレットを生成した場合は、それぞれを confluent.telemetry.api.key および confluent.telemetry.api.secret テキストボックスに入力します。
- Confluent Cloud Console を使用してキーとシークレットを生成した場合は、Upload key and secret をクリックして、前にダウンロードしたファイルに移動します。
Continue をクリックします。
Confluent Cloud Console の Health+ ページに移動して、データが受信中であることを確認します。Confluent Platform クラスターのタイルに Running と表示されているはずです。
クラスターのタイルをクリックして、テレメトリデータを表示します。

Ansible Playbooks for Confluent Platform を使用して Confluent Platform のインストールを管理する場合は、以下の構成オーバーライドをすべての Confluent Platform ロールに追加し、変更をデプロイします。

telemetry_enabled: true
telemetry_api_key: <api_key>
telemetry_api_secret: <api_secret>

Confluent Server の場合は、サーバー構成ファイルに以下の行を追加して、Telemetry Reporter を有効にします。サーバー構成ファイルのデフォルトの場所は $CONFLUENT_HOME/etc/kafka/server.properties です。前に生成したキーとシークレットで、<api_key> と <api_secret> を置き換えます。

confluent.telemetry.enabled=true
confluent.telemetry.api.key=<api_key>
confluent.telemetry.api.secret=<api_secret>

サーバー構成を保存し、Confluent Server を再起動します。

注釈

Confluent Server を再起動しない場合は、kafka-config CLI で動的構成を使用して、これらの構成を追加できます。詳細については、「再起動なしでのテレメトリの有効化」を参照してください。

Confluent Server 以外のすべての Confluent Platform コンポーネントの場合は、対応するサービスの構成ファイルに以下の行を追加して、テレメトリーレポートを有効にします。コンポーネントの構成ファイルのデフォルトの場所は $CONFLUENT_HOME/etc/<component_name>/<component_name>.properties です。

metric.reporters=io.confluent.telemetry.reporter.TelemetryReporter
confluent.telemetry.enabled=true
confluent.telemetry.api.key=<api_key>
confluent.telemetry.api.secret=<api_secret>

ファイルを保存し、サービスを再起動して新しい構成をデプロイします。サービスの再起動には、confluent local services <component_name> stop および confluent local services <component_name> start コマンドを使用します。

注釈

metric.reporters の設定は、Confluent Server では不要ですが、それ以外のすべての Confluent Platform コンポーネントでは必要です。

プロキシの構成¶

Confluent Telemetry Reporter は、認証済みの HTTP プロキシ経由でのテレメトリデータのルーティングをサポートしています。これらの環境では、サーバー構成ファイルで以下のパラメーターを設定することにより、プロキシ経由のテレメトリデータ送信を有効にします。

confluent.telemetry.proxy.url=http://<proxy_server_ip>:<proxy_server_port>
confluent.telemetry.proxy.username=<proxy-username>
confluent.telemetry.proxy.password=<proxy-password>

送信データの内容およびデータの用途¶

特定の Confluent Platform コンポーネントに対して Confluent Telemetry Reporter を有効にした場合、Confluent は、その Confluent Platform コンポーネントに関する以下のようなメトリクスを収集します。

ランタイムパフォーマンスのメトリクス
Kafka のバージョン
Confluent Platform のバージョン
該当する Confluent Platform コンポーネントに対して有効な一意の識別子
Kafka クラスターの一意の識別子
組織の一意の識別子

データは暗号化された接続を使用して Confluent Server に送信されます（デフォルトでは 1 分に 1 回）。結果として得られるデータは、Confluent が Health+ をお客様に提供し、Confluent 製品や Confluent サービスをメンテナンスおよび改善するために使用されます。

このデータを送信するには、各 Confluent Platform コンポーネントで構成フラグを設定して、送信を有効にします。これらの構成フラグを削除すると、データの送信をいつでも停止することができます。

動的構成¶

注釈

現時点では、動的構成は Kafka ブローカーにのみ適用されます。

動的構成をクラスターに適用する方法については、「Kafka の動的構成」を参照してください。

再起動なしでのテレメトリの有効化¶

Confluent Server を使用している場合は、以下のコマンドを使用することにより、再起動なしで Telemetry Reporter を有効にすることができます。前に生成したキーとシークレットで、<api_key> と <api_secret> を置き換えます。

$CONFLUENT_HOME/bin/kafka-configs --bootstrap-server localhost:9092 \
--alter --entity-type brokers --entity-default \
--add-config confluent.telemetry.enabled=true, \
confluent.telemetry.api.key=<api_key>, \
confluent.telemetry.api.secret=<api_secret>

サポートされる動的構成プロパティ¶

confluent.telemetry.enabled
confluent.telemetry.api.key
confluent.telemetry.api.secret
confluent.telemetry.proxy.url
confluent.telemetry.proxy.username
confluent.telemetry.proxy.password

Disable Telemetry¶

For all Confluent Platform components that have telemetry enabled, set the confluent.telemetry.enabled config to false and restart the component.

confluent.telemetry.enabled=false

Confluent Server を使用している場合は、以下のコマンドを使用することにより、再起動なしで Telemetry Reporter を有効にすることができます。前に生成したキーとシークレットで、<api_key> と <api_secret> を置き換えます。

  $CONFLUENT_HOME/bin/kafka-configs --bootstrap-server localhost:9092 \
  --alter --entity-type brokers --entity-default \
  --add-config confluent.telemetry.enabled=false, \
  confluent.telemetry.api.key=<api_key>, \
  confluent.telemetry.api.secret=<api_secret>