テレメトリーデータの収集と分析
Red Hat Developer Hub のエクスペリエンスを強化するために、Web 分析とシステム観測データを収集および分析します。
概要
第1章 テレメトリーデータの収集と分析 リンクのコピーリンクがクリップボードにコピーされました!
テレメトリーデータ収集機能は、テレメトリーデータを収集および分析して、Red Hat Developer Hub のエクスペリエンスを向上させるのに役立ちます。この機能はデフォルトで有効化されています。
Red Hat は以下のデータを収集して分析します。
- Web 分析
Web 分析ではセグメントツールを使用します。これは、Red Hat Developer Hub でのユーザーの行動とやり取りを追跡するものです。具体的には、次のものを追跡します。
- ページ訪問やリンクまたはボタンのクリックのイベント。
- システム関連の情報 (ロケール、タイムゾーン、ブラウザーやオペレーティングシステムの詳細を含むユーザーエージェントなど)。
- ページ関連の情報 (タイトル、カテゴリー、拡張機能名、URL、パス、リファラー、検索パラメーターなど)。
-
匿名の IP アドレス (
0.0.0.0 として記録)。 - 匿名化されたユーザー名ハッシュ。これは、RHDH アプリケーションの一意のユーザー数を識別するためにのみ使用される一意の識別子です。
- システムの可観測性
システム観測性では OpenTelemetry ツールが使用されます。RHDH のパフォーマンスの追跡です。具体的には、次のメトリクスを追跡します。
- CPU 使用率、メモリー使用量、その他のパフォーマンス指標などの主要なシステムメトリクス。
- ロケール、タイムゾーン、ユーザーエージェントなどのシステムコンポーネントに関する情報 (ブラウザーとオペレーティングシステムの詳細を含む)。
- トレースとログはシステムプロセスを監視し、RHDH のパフォーマンスに影響を与える潜在的な問題をトラブルシューティングできるようにします。
RHDH を使用すると、ニーズに応じて Web Analytics と System Observability の設定をカスタマイズできます。
第2章 RHDH でのテレメトリーデータ収集の無効化 リンクのコピーリンクがクリップボードにコピーされました!
テレメトリーデータの収集を無効にするには、Helm チャートまたは Red Hat Developer Hub Operator 設定を使用して analytics-provider-segment プラグインを無効にする必要があります。
管理者は、ニーズに応じてテレメトリーデータ収集機能を無効にできます。たとえば、エアギャップ環境では、この機能を無効にすることで、RHDH アプリケーションの応答性に影響を与える不要な送信要求を回避できます。詳細は、RHDH でのテレメトリーデータ収集の無効化 セクションを参照してください。
2.1. Operator を使用したテレメトリーデータ収集の無効化 リンクのコピーリンクがクリップボードにコピーされました!
Operator を使用してテレメトリーデータ収集機能を無効にできます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Operator を使用して OpenShift Container Platform に Red Hat Developer Hub をインストールした。
手順
以下のいずれかの手順を実行します。
-
dynamic-plugins-rhdhConfigMap ファイルを作成し、analytics-provider-segmentプラグインを設定していない場合は、このプラグインをプラグインのリストに追加し、そのplugins.disabledパラメーターをtrueに設定します。 -
dynamic-plugins-rhdhConfigMap ファイルを作成し、analytics-provider-segmentプラグインを設定済みの場合は、プラグインのリストでこのプラグインを検索し、そのplugins.disabledパラメーターをtrueに設定します。 ConfigMap ファイルをまだ作成していない場合は、次の YAML コードを使用して作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
dynamicPluginsConfigMapNameパラメーターの値を、Backstageカスタムリソースのdynamic-plugins-rhdhconfig map の名前に設定します。# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 設定変更を保存します。
2.2. Helm チャートを使用したテレメトリーデータ収集の無効化 リンクのコピーリンクがクリップボードにコピーされました!
Helm チャートを使用してテレメトリーデータ収集機能を無効にできます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Helm チャートを使用して、OpenShift Container Platform に Red Hat Developer Hub をインストールしている。
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブで、Helm ビューに移動して Helm リリースのリストを表示します。
使用する Helm リリースの オーバーフロー メニューをクリックし、Upgrade を選択します。
注記Create ボタンをクリックして新しい Helm リリースを作成し、設定を編集してテレメトリーを無効にすることもできます。
Form ビューか YAML ビューを使用して、Helm 設定を編集します。
Form view を使用する場合
- Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application を展開します。
- Add list of dynamic plugins that should be installed in the backstage application リンクをクリックします。
以下のいずれかの手順を実行します。
プラグインを設定していない場合は、Package specification of the dynamic plugin to install. It should be usable by the npm pack command. フィールドに次の値を追加します。
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment-
プラグインを設定済みの場合は、Package specification of the dynamic plugin to install. It should be usable by the npm pack command. フィールドに
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segmentという値があることを確認します。
- Disable the plugin チェックボックスをオンにします。
- Upgrade をクリックします。
YAML view を使用する場合
以下のいずれかの手順を実行します。
プラグインを設定していない場合は、
values.yamlHelm 設定ファイルに次の YAML コードを追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
プラグインを設定済みの場合は、Helm 設定でプラグインを検索し、
plugins.disabledパラメーターの値をtrueに設定します。
- Upgrade をクリックします。
第3章 RHDH でのテレメトリーデータ収集の有効化 リンクのコピーリンクがクリップボードにコピーされました!
テレメトリーデータ収集機能はデフォルトで有効になっています。ただし、この機能を無効にしていて再度有効にする場合は、Helm チャートまたは Red Hat Developer Hub Operator 設定を使用して analytics-provider-segment プラグインを有効にする必要があります。
3.1. Operator を使用したテレメトリーデータ収集の有効化 リンクのコピーリンクがクリップボードにコピーされました!
Operator を使用してテレメトリーデータ収集機能を有効にできます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Operator を使用して OpenShift Container Platform に Red Hat Developer Hub をインストールした。
手順
以下のいずれかの手順を実行します。
-
dynamic-plugins-rhdhConfigMap ファイルを作成し、analytics-provider-segmentプラグインを設定していない場合は、このプラグインをプラグインのリストに追加し、そのplugins.disabledパラメーターをfalseに設定します。 -
dynamic-plugins-rhdhConfigMap ファイルを作成し、analytics-provider-segmentプラグインを設定済みの場合は、プラグインのリストでこのプラグインを検索し、そのplugins.disabledパラメーターをfalseに設定します。 ConfigMap ファイルをまだ作成していない場合は、次の YAML コードを使用して作成します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
dynamicPluginsConfigMapNameパラメーターの値を、Backstageカスタムリソースのdynamic-plugins-rhdhconfig map の名前に設定します。# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 設定変更を保存します。
3.2. Helm チャートを使用したテレメトリーデータ収集の有効化 リンクのコピーリンクがクリップボードにコピーされました!
Helm チャートを使用してテレメトリーデータ収集機能を有効にできます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Helm チャートを使用して、OpenShift Container Platform に Red Hat Developer Hub をインストールしている。
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブで、Helm ビューに移動して Helm リリースのリストを表示します。
使用する Helm リリースの オーバーフロー メニューをクリックし、Upgrade を選択します。
注記Create ボタンをクリックして新しい Helm リリースを作成し、設定を編集してテレメトリーを有効にすることもできます。
Form ビューか YAML ビューを使用して、Helm 設定を編集します。
Form view を使用する場合
- Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application を展開します。
- Add list of dynamic plugins that should be installed in the backstage application リンクをクリックします。
以下のいずれかの手順を実行します。
プラグインを設定していない場合は、Package specification of the dynamic plugin to install. It should be usable by the npm pack command. フィールドに次の値を追加します。
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment-
プラグインを設定済みの場合は、Package specification of the dynamic plugin to install. It should be usable by the npm pack command. フィールドに
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segmentという値があることを確認します。
- Disable the plugin チェックボックスをオフにします。
- Upgrade をクリックします。
YAML view を使用する場合
以下のいずれかの手順を実行します。
プラグインを設定していない場合は、Helm 設定ファイルに次の YAML コードを追加します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
プラグインを設定済みの場合は、Helm 設定でプラグインを検索し、
plugins.disabledパラメーターの値をfalseに設定します。
- Upgrade をクリックします。
第4章 Segment ソースのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
analytics-provider-segment プラグインは、収集された Web 分析データをデフォルトで Red Hat に送信します。ただし、ニーズに応じて、Web 分析データを受信する新しい Segment ソースを設定することができます。設定には、Segment ソースを参照する一意の Segment 書き込みキーが必要です。
アプリケーションユーザー向けに独自の Web 分析データ収集通知を作成します。
4.1. Operator を使用した Segment ソースのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub Operator を使用して、Segment ソースとの統合を設定できます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Operator を使用して OpenShift Container Platform に Red Hat Developer Hub をインストールした。
手順
Backstageカスタムリソース (CR) に次の YAML コードを追加します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
<segment_key>は、Segment ソースの一意の識別子に置き換えます。
- 設定変更を保存します。
4.2. Helm チャートを使用した Segment ソースのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Developer Hub Helm チャートを使用して、Segment ソースとの統合を設定できます。
前提条件
- OpenShift Container Platform Web コンソールに管理者としてログインしている。
- Helm チャートを使用して、OpenShift Container Platform に Red Hat Developer Hub をインストールしている。
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブで、Helm ビューに移動して Helm リリースのリストを表示します。
- 使用する Helm リリースの オーバーフロー メニューをクリックし、Upgrade を選択します。
Form ビューか YAML ビューを使用して、Helm 設定を編集します。
Form view を使用する場合
- Root Schema → Backstage Chart Schema → Backstage Parameters → Backstage container environment variables を展開します。
- Add Backstage container environment variables リンクをクリックします。
Segment キーの名前と値を入力します。
- Upgrade をクリックします。
YAML view を使用する場合
以下の YAML コードを Helm 設定ファイルに追加します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
<segment_key>は、Segment ソースの一意の識別子に置き換えます。
- Upgrade をクリックします。
関連情報
- 同じデータセットを収集して分析する方法には、テレメトリーデータ収集 を参照してください。