Red Hat Developer Hub の Adoption Insights

Red Hat Developer Hub 1.5

社内開発者ポータル内での導入状況とエンゲージメントに関する詳細な分析を提供する

Red Hat Customer Content Services

概要

プラットフォームエンジニアは、RHDH で Adoption Insights を設定して重要なメトリクスと傾向を視覚化し、組織内の RHDH の使用状況に関する情報を取得できます。

第1章 Adoption Insights

重要

このセクションでは、Adoption Insights プラグインの開発者プレビュー機能を説明します。開発者プレビュー機能は、Red Hat ではいかなる形でもサポートされていません。また、機能的には完全ではなく、実稼働環境に対応していません。開発者プレビュー機能を実稼働ワークロードまたはビジネスクリティカルなワークロードには使用しないでください。開発者プレビュー機能は、Red Hat 製品に追加される可能性がある機能をいち早く提供することを目的としています。お客様はこの機能を使用してテストし、開発プロセス中にフィードバックを提供できます。開発者プレビュー機能は、ドキュメントが提供されていない場合があり、随時変更または削除される可能性があります。また、限定的なテストしか行われていません。Red Hat は、関連する SLA なしで、開発者プレビュー機能に関するフィードバックを送信する方法を提供する場合があります。

Red Hat 開発者プレビュー機能のサポート範囲の詳細は、開発者プレビューのサポート範囲を参照してください。

1.1. Adoption Insights について

組織が生成するデータイベントの数が増加するにつれて、社内開発者ポータルの導入状況とエンゲージメントのメトリクスに関する詳細な分析情報の必要性が高まっています。このような分析情報は、プラットフォームエンジニアがデータに基づいて意思決定を行い、パフォーマンスや使いやすさを向上させ、情報を実用的なものに変換するのに役立ちます。

Red Hat Developer Hub の Adoption Insights を使用すると、重要なメトリクスと傾向を視覚化し、組織内の Developer Hub の使用状況に関する情報を取得できます。Developer Hub の Adoption Insights によって提供される情報により、改善領域を特定し、人気のある機能を明らかにして、導入に関する目標に向けた進捗状況を評価できます。また、ライセンスを持つユーザー数に対するユーザーの増加状況を監視し、経時的な傾向を特定することもできます。

注記

現在、Adoption Insights プラグインは、組み込みの plugin-analytics-provider-segment プラグインと一緒に使用することはできません。回避策は、Red Hat Developer Hub の Adoption Insights を参照してください。

Developer Hub の Adoption Insights ダッシュボードには、次のカードが含まれています。

Active users
Total nuber of users
Top catalog entities
Top 3 templates
Top 3 techdocs
Top 3 plugins
Portal searches

1.2. Red Hat Developer Hub への Adoption Insights プラグインのインストール

Red Hat Developer Hub の Adoption Insights プラグインは、手動でインストールする必要があります。

手順

Adoption Insights プラグインを有効にするには、次の手順を実行します。

次の例に示すように、app-config-dynamic.yaml ファイルに次の設定を追加します。

  - package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
    disabled: true
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:bs_1.35.1__0.0.3!red-hat-developer-hub-backstage-plugin-adoption-insights
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-adoption-insights:
            appIcons:
              - name: adoptionInsightsIcon
                importName: AdoptionInsightsIcon
            dynamicRoutes:
              - path: /adoption-insights
                importName: AdoptionInsightsPage
                menuItem:
                  icon: adoptionInsightsIcon
                  text: Adoption Insights
            menuItems:
              adoption-insights:
                parent: admin
                icon: adoptionInsightsIcon
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights-backend:bs_1.35.1__0.0.4!red-hat-developer-hub-backstage-plugin-adoption-insights-backend
    disabled: false
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights:
            apiFactories:
              - importName: AdoptionInsightsAnalyticsApiFactory

  - package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
    disabled: true
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:bs_1.35.1__0.0.3!red-hat-developer-hub-backstage-plugin-adoption-insights
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-adoption-insights:
            appIcons:
              - name: adoptionInsightsIcon
                importName: AdoptionInsightsIcon
            dynamicRoutes:
              - path: /adoption-insights
                importName: AdoptionInsightsPage
                menuItem:
                  icon: adoptionInsightsIcon
                  text: Adoption Insights
            menuItems:
              adoption-insights:
                parent: admin
                icon: adoptionInsightsIcon
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights-backend:bs_1.35.1__0.0.4!red-hat-developer-hub-backstage-plugin-adoption-insights-backend
    disabled: false
  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights:bs_1.35.1__0.0.2!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights
    disabled: false
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights:
            apiFactories:
              - importName: AdoptionInsightsAnalyticsApiFactory

Copy to Clipboard

注記

現在、Adoption Insights プラグインは、組み込みの plugin-analytics-provider-segment プラグインと一緒に使用することはできません。Adoption Insights を使用するには、plugin-analytics-provider-segment プラグインを無効にする必要があります。

オプション: 次の例に示すように、管理者ではないユーザーに必要な RBAC 権限を設定します。

p, role:default/_<your_team>_, adoption-insights.events.read, read, allow
g, user:default/_<your_user>_, role:default/_<your_team>_

p, role:default/_<your_team>_, adoption-insights.events.read, read, allow
g, user:default/_<your_user>_, role:default/_<your_team>_

Copy to Clipboard

Red Hat Developer Hub の権限ポリシーを参照してください。

1.3. Red Hat Developer Hub の Adoption Insights プラグインの設定

Red Hat Developer Hub Helm チャートまたは Red Hat Developer Hub Operator ConfigMap を設定することで、Adoption Insights プラグインを有効にできます。

手順

Developer Hub で Adoption Insights プラグインを設定するには、Red Hat Developer Hub の app-config.yaml ファイルに次のコードを追加します。
app-config.yaml フラグメント
```
app:
  analytics:
    adoptionInsights:
      maxBufferSize: 20 
      flushInterval: 5000 
      debug: false 
      licensedUsers: 2000 
```
```
app:
  analytics:
    adoptionInsights:
      maxBufferSize: 20 
```
1
```
      flushInterval: 5000 
```
2
```
      debug: false 
```
3
```
      licensedUsers: 2000 
```
4
Copy to Clipboard
1
(オプション) イベントバッチ処理の最大バッファーサイズを指定します。デフォルト値は 20 です。
2
(オプション) イベントバッチ処理のフラッシュ間隔をミリ秒単位で指定します。デフォルト値は 5000ms です。
3
(オプション) デフォルト値は false です。
4
(オプション) RHDH インスタンスにアクセスできる、ライセンスを持つユーザーの最大数を指定します。デフォルト値は 100 です。

1.4. Red Hat Developer Hub の Adoption Insights の使用

Developer Hub アプリケーションのナビゲーションメニューで、Administration → Adoption Insights をクリックします。

1.4.1. データメトリクスの期間の設定

任意の時間範囲を使用してデータメトリクス期間を設定できます。Today、Last week、Last month、Last 28 days (デフォルト)、Last year、Date range… などを使用できます。

手順

画面の上部にあるドロップダウンリストをクリックして選択肢を表示します。
データメトリクスを表示する期間の選択肢を選択します。

1.5. Adoption Insights カードの表示

1.5.1. アクティブユーザー数の表示

Active users カードには、指定した期間内のアクティブユーザーの合計数が表示されます。また、New users と Returning users の内訳の比較を折れ線グラフ/面グラフ形式で提供します。ユーザーデータを .csv 形式でエクスポートできます。

Returning users: Developer Hub にログインしている既存ユーザー
New users: Developer Hub に登録してログインした新規ユーザー

手順

Developer Hub インスタンス内のアクティブユーザーのリストを表示するには、Administration → Adoption Insights に移動し、Active users カードを確認します。
特定の日の正確なユーザー数を表示するには、Active users カードの対応する日付にマウスカーソルを合わせます。
ユーザーデータを .csv 形式でエクスポートするには、Export CSV ラベルをクリックします。

1.5.2. ユーザー総数の表示

このカードには、Red Hat Developer Hub を使用するライセンスを持つユーザーの合計数が表示されます。また、Logged-in users と Licensed users の数を数値とパーセンテージで比較することもできます。

Logged-in users: 現在 Developer Hub にログインしているユーザーの合計数 (ライセンスを持つユーザーとライセンスを持たないユーザーを含む)
Licensed users: Developer Hub にログインしている、ライセンスを持つユーザーの総数。ライセンスを持つユーザーの数は、Developer Hub の app-config.yaml ファイルで設定できます。

手順

Developer Hub インスタンス内のユーザーの合計数を数値とパーセンテージの形式で表示するには、Administration → Adoption Insights に移動し、Total number of users カードを確認します。
ライセンスを持つユーザーの総数に含まれるログインしているユーザーの合計数をパーセンテージで表示するには、Total number of users にマウスカーソルを合わせます。

1.5.3. 上位のカタログエンティティーの表示

このカードには、最も多く閲覧されたカタログエンティティー (コンポーネント、API など) とドキュメントエントリー (使用状況統計を含む) が表形式で表示されます。

各項目には、以下の詳細が表示されます。

名前: カタログの名前。
kind: カタログのタイプ
最後に使用 済み : カタログが最後に使用された時刻
views: カタログが閲覧された回数

手順

Developer Hub インスタンスで最もよく使用されるカタログエンティティーを表示するには、Administration → Adoption Insights に移動し、Top catalog entities カードを確認します。
表示されているカタログエンティティーの詳細を確認するには、カタログエンティティー名にマウスカーソルを合わせます。

1.5.4. 上位 3 つのテンプレートの表示

このカードには、最もよく使用される 3 つのテンプレートが表形式で表示されます。3 rows の横にある下矢印をクリックすると、よく使用されるテンプレートの完全なリストを表示できます。

テンプレートの名前。
主に : このテンプレートを使用する ユーザーのタイプが最も頻繁に使用されます。
実行: このテンプレートが使用された回数

手順

Developer Hub インスタンスで最もよく使用されるテンプレートを表示するには、Administration → Adoption Insights に移動し、Top 3 templates カードを確認します。
表示されているテンプレートの詳細を確認するには、テンプレート名にマウスカーソルを合わせます。

1.5.5. 上位 3 つの TechDoc の表示

このカードには、合計閲覧回数を含む、最も多く閲覧されたドキュメントエントリーが表形式で表示されます。

Name: ドキュメントの名前
Entity: ドキュメントのタイプ
最後に使用 した : ドキュメントが最後に見られた時刻
Views: ドキュメントがアクセスされた回数

手順

Developer Hub インスタンスで最もよく使用されるテンプレートを表示するには、Administration → Adoption Insights に移動し、Top 3 techdocs カードを確認します。
表示されている TechDoc の詳細を確認するには、TechDoc 名にマウスカーソルを合わせます。

1.5.6. 上位 3 つのプラグインの表示

このカードには、最もよく使用される 3 つのプラグインが表形式で表示されます。3 rows の横にある下矢印をクリックすると、よく使用されるプラグインの完全なリストを表示できます。

name: プラグインの名前
トレンド: プラグインのグラフとしての適合性
views: このプラグインが見た回数

手順

Developer Hub インスタンスで最もよく使用されるプラグインとプラグインページのアクセス傾向を表示するには、Administration → Adoption Insights に移動し、Top 3 plugins カードを確認します。
表示されているプラグインの詳細を確認するには、プラグイン名にマウスカーソルを合わせます。

1.6. 表示するレコード数の変更

1.6.1. Top catalog entities に表示するレコード数の変更

Top catalog entities カードに表示するレコードの数を変更できます。表示するレコード数を以下から選択できます。

Top 3
Top 5
Top 10
Top 20

デフォルトでは、最も多く閲覧された上位 3 つのカタログエンティティーが表示されます。

手順

Administration → Adoption Insights に移動し、3 rows の横にある下矢印をクリックして、表示されるレコードの数を変更します。

1.6.2. Top 3 templates に表示するレコード数の変更

Top 3 templates カードに表示するレコードの数を変更できます。表示するレコード数を以下から選択できます。

Top 3
Top 5
Top 10
Top 20

デフォルトでは、最も多く閲覧された上位 3 つのテンプレートが表示されます。

手順

Administration → Adoption Insights に移動し、3 rows の横にある下矢印をクリックして、表示されるレコードの数を変更します。

1.6.3. Top 3 techdocs に表示するレコード数の変更

Top 3 techdocs カードに表示するレコードの数を変更できます。表示するレコード数を以下から選択できます。

Top 3
Top 5
Top 10
Top 20

デフォルトでは、最も多く閲覧された上位 3 つの TechDoc が表示されます。

手順

Administration → Adoption Insights に移動し、3 rows の横にある下矢印をクリックして、表示されるレコードの数を変更します。

1.6.4. Top 3 plugins に表示するレコード数の変更

Top 3 plugins カードに表示するレコードの数を変更できます。表示するレコード数を以下から選択できます。

Top 3
Top 5
Top 10
Top 20

デフォルトでは、最も多く閲覧された上位 3 つのプラグインが表示されます。

手順

Administration → Adoption Insights に移動し、3 rows の横にある下矢印をクリックして、表示されるレコードの数を変更します。

1.7. レコードをフィルタリングして、Top catalog entities に特定のカタログエンティティーを表示する

タイトルのドロップダウンフィルターを使用して、テーブルの表示を任意の項目でフィルタリングできます。デフォルトでは、Top catalog entities カードには、Developer Hub インスタンス内のすべての項目が表示されます。

手順

テーブルに特定のカタログエンティティーを表示するには、次の手順を実行します。

Administration → Adoption Insights に移動し、Top catalog entities カードのドロップダウンフィルターをクリックして、表示する項目を選択します。

1.8. 検索の表示

searches カードでは、次のデータを表示できます。

ポータルの検索数と経時的な傾向をグラフで視覚化します。
期間内の合計数をカードタイトルに表示します。
選択した期間に応じて、時間/日/週/月ごとの平均数を表示します。

法律上の通知

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.