Confluent Telemetry Reporter¶
概要¶
Confluent Telemetry Reporter は、サービスに関するメタデータを Confluent にプッシュするために各 Confluent Platform サービス内で動作するプラグインです。Telemetry Reporter により、メタデータに基づく製品機能（Health+ など）が有効になります。データは HTTP を介して送信され、暗号化された接続が使用されます。
重要
- クラスターで 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 に送信されません。
利用可能なメトリクスのリストについては、「Telemetry Reporter のメトリクス」を参照してください。
インストール¶
Confluent Telemetry Reporter は、Confluent Platform のフルインストールの一部としてインストールされます。パッケージを個別にインストールする場合は、yum install confluent-telemetry を使用して、Telemetry Reporter が確実にインストールされるようにします。
Confluent Cloud に対するテレメトリレポートの有効化¶
- 前提条件
- Confluent Cloud へのアクセス
- インターネット接続（直接またはプロキシ経由）
- Confluent Platform 6.0 以降
Confluent Cloud での認証のための Cloud API キー を作成します。その例を次に示します。
ccloud login
ccloud api-key create --resource cloud
注釈
"必ず" Cloud API キーを使用してください。Kafka と通信するために使用する Cluster API キーを使用すると、認証エラーになります。
Ansible Playbooks for Confluent Platform を使用する構成¶
Ansible Playbooks for Confluent Platform を使用して Confluent Platform のインストールを管理する場合は、以下の構成オーバーライドをすべての Confluent Platform ロールに追加し、変更をデプロイします。
telemetry_enabled: true
telemetry_api_key: <api-key>
telemetry_api_secret: <api-secret>
Confluent for Kubernetes を使用する構成¶
Confluent for Kubernetes （CFK）を使用して Confluent Platform を管理する場合は、Kubernetes 用の Confluent に関するドキュメント の説明に従ってテレメトリを有効にできます。
カスタムデプロイメントの構成¶
Confluent Server 以外のすべての Confluent Platform コンポーネントの場合は、サービスの構成ファイルに以下の行を追加し、サービスを再開して新しい構成をデプロイすることにより、テレメトリレポートを有効にします。上記で生成されたキーおよびシークレットで、<API_KEY> および <API_SECRET> を置き換えます。
metric.reporters=io.confluent.telemetry.reporter.TelemetryReporter
confluent.telemetry.enabled=true
confluent.telemetry.api.key=<API_KEY>
confluent.telemetry.api.secret=<API_SECRET>
Confluent Server の場合、metric.reporters の構成は不要です。以下の行を Confluent Server 構成ファイルに追加し、Confluent Server を再起動します。Confluent Server を再起動しない場合は、動的構成および kafka-config CLI を使用して、これらの構成を追加することができます。
confluent.telemetry.enabled=true
confluent.telemetry.api.key=<API_KEY>
confluent.telemetry.api.secret=<API_SECRET>
プロキシの構成¶
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 サーバーに送信されます（デフォルトでは 1 分 に 1 回）。結果として得られるデータは、Confluent が Health+ をお客様に提供し、Confluent 製品や Confluent サービスをメンテナンスおよび改善するために使用されます。このデータを送信するには、各 Confluent Platform コンポーネントで構成フラグを設定して、送信を有効にします。これらの構成フラグを削除すると、データの送信をいつでも停止することができます。
動的構成¶
注釈
現時点では、動的構成は Kafka ブローカーにのみ適用されます。
動的構成をクラスターに適用する方法については、「Kafka の動的構成」を参照してください。
再起動なしでのテレメトリの有効化¶
Confluent Server を使用している場合は、以下のコマンドを使用することにより、再起動なしで Telemetry Reporter を有効にすることができます。上記で生成されたキーおよびシークレットで、<API_KEY> および <API_SECRET> を置き換えます。
./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.enabledconfluent.telemetry.api.keyconfluent.telemetry.api.secretconfluent.telemetry.proxy.urlconfluent.telemetry.proxy.usernameconfluent.telemetry.proxy.password