在 Red Hat Developer Hub 中使用 Insights
在内部开发人员门户中针对采用和互动提供详细分析
摘要
第 1 章 采用 Insights 复制链接链接已复制到粘贴板!
本节论述了 Adoption Insights 插件中的开发者预览功能。Developer Preview(开发人员预览)功能不被红帽支持,其功能可能并不完善且不是生产环境就绪。不要将开发人员预览功能用于生产环境或业务关键型工作负载。开发人员预览功能在红帽产品产品中包括早期对功能的访问。客户可以使用这些功能在开发过程中测试并提供反馈。开发人员预览功能可能没有任何文档,可以随时更改或删除,并且已获得有限的测试。红帽可能会提供在没有关联 SLA 的情况下提交对开发人员预览功能的反馈。
有关红帽开发人员预览功能的支持范围的更多信息,请参阅 开发人员预览支持范围。
1.1. 关于采用 Insights 复制链接链接已复制到粘贴板!
随着机构产生更多的数据事件,对内部开发人员门户的采用和参与指标有越来越多的需求。这些见解帮助平台工程师做出了数据驱动的决策,以改进其性能、可用性,并将其转换为可操作见解。
您可以在 Red Hat Developer Hub 中使用 Adoption Insights 来视觉化关键指标和趋势,以获取有关您机构中使用的 Developer Hub 的信息。Developer Hub 中 Adoption Insights 提供的信息有改进、突出显示的流行功能,并评估采用目标的进度。您还可以监控用户对许可证用户的增长,并识别一段时间内的趋势。
目前,Adoption Insights 插件无法与内置 插件一起使用,-analytics-provider-segment 插件。如需临时解决方案,请参阅 Red Hat Developer Hub 中的 Adoption Insights。
Developer Hub 中的 Adoption Insights 仪表板包括以下卡:
- 活跃用户
- 用户的 nuber 总数
- 顶级目录实体
- 前 3 个模板
- 前 3 个 HEKETI
- 前 3 个插件
- 门户搜索
1.2. 在 Red Hat Developer Hub 中安装 Adoption Insights 插件 复制链接链接已复制到粘贴板!
对于 Red Hat Developer Hub 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注意目前,Adoption Insights 插件无法与内置
插件一起使用,-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>_
1.3. 在 Red Hat Developer Hub 中配置采用 Insights 插件 复制链接链接已复制到粘贴板!
您可以通过配置 Red Hat Developer Hub Helm chart 或 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: 201 flushInterval: 50002 debug: false3 licensedUsers: 20004
1.4. 在 Red Hat Developer Hub 中使用 Insights 复制链接链接已复制到粘贴板!
在 Developer Hub 应用程序中,在导航菜单中点 Administration → Adoption Insights。
1.4.1. 设置数据指标的持续时间 复制链接链接已复制到粘贴板!
您可以使用任何时间范围(如 Today、lastweek、lastmonth、Last 28 days (default)、Last year 或 Date range… )来设置数据指标持续时间。
流程
- 在屏幕的顶部,单击下拉列表以显示选择。
- 选择您要查看数据指标的持续时间选择。
1.5. 查看采用 Insights 卡 复制链接链接已复制到粘贴板!
1.5.1. 查看活跃用户 复制链接链接已复制到粘贴板!
Active users 卡显示指定时间范围的活动用户总数。它还提供了新用户的分类比较,并以 line/area 图形格式 返回用户。您可以使用 .csv 格式导出用户数据。
- 返回用户 :已登录到 Developer Hub 的现有用户
- 新用户 :注册并登录到 Developer Hub 的新用户
流程
- 要在 Developer Hub 实例中查看活跃用户列表,请转至 Administration → Adoption Insights,请参阅 Active users 卡。
- 要查看特定日期的确切用户数量,请将鼠标悬停在 Active users 卡中的相应日期上。
- 要以 .csv 格式导出用户数据,点 Export CSV 标签。
1.5.2. 查看用户总数 复制链接链接已复制到粘贴板!
此卡显示有许可证使用 Red Hat Developer Hub 的用户总数。它还提供了以数字和百分比形式的 登录用户 和许可证 用户数量的比较。
- 登录用户 :用户 总数,包括许可和未许可的用户,当前登录到 Developer Hub
- 许可用户 :在 Developer Hub 中登录的许可用户的总数。您可以在 Developer Hub app-config.yaml 文件中设置许可用户数量。
流程
- 要以数字和百分比形式查看 Developer Hub 实例中用户总数,请转至 Administration → Adoption Insights,并查看 用户卡的总数。
- 要在许可证用户总数中查看登录用户总数的百分比,将鼠标悬停在用户 总数中的工具提示上。
1.5.3. 查看顶层目录实体 复制链接链接已复制到粘贴板!
此卡列出了查看的目录实体(如组件、API 等)和文档条目,包括表中的使用统计信息。
每个项目会显示 Name,Kind,Last used, 和 Views。
- 名称 :目录的名称
- kind :目录类型
- 最后使用 :目录最后一次使用的时间
- 视图 :查看目录的次数
流程
- 要在 Developer Hub 实例中查看最常用的目录实体,请转至 Administration → Adoption Insights,并查看 Top 目录实体 卡。
- 要了解更多有关显示的目录实体的信息,请将鼠标悬停在目录实体名称上。
1.5.4. 查看前 3 个模板 复制链接链接已复制到粘贴板!
此卡列出了表中最常用的三个模板。您可以单击 3 行 旁边的向下箭头,以查看常用模板的完整列表。
- 名称 :模板的名称
- 大多数情况下由: 使用此模板的用户类型
- 执行 :使用此模板的次数
流程
- 要查看 Developer Hub 实例中最常用的模板,请转至 Administration → Adoption Insights,并查看 Top 3 模板 卡。
- 要了解更多有关显示的模板的信息,请将鼠标悬停在模板名称上。
1.5.5. 查看前 3 个 HEKETI 复制链接链接已复制到粘贴板!
此卡列出了表中查看最多的文档条目,包括总视图。
- 名称 : TechDoc 的名称
- 实体 : TechDoc 的类型
- 最后使用: TechDoc 最后一次查看的时间
- 视图 :访问 TechDocs 的次数
流程
- 要查看 Developer Hub 实例中最常用的模板,请转至 Administration → Adoption Insights,并查看 Top 3 wagon 卡。
- 要了解有关显示的 HEKETI 的更多信息,请将鼠标悬停在 HEKETI 名称上。
1.5.6. 查看前 3 个插件 复制链接链接已复制到粘贴板!
这个卡列出了表中最常用的三个插件。您可以点 3 行 旁边的下箭头来查看常用插件的完整列表。
- 名称 :插件的名称
- 趋势 :插件的 Popularity 作为图形
- 视图 :此插件查看的次数
流程
- 要查看最常用的插件,以及插件页面访问 Developer Hub 实例中的趋势,请转至 Administration → Adoption Insights,并查看 Top 3 插件 卡。
- 要了解更多有关显示的插件的信息,请将鼠标悬停在插件名称上。
1.6. 修改显示的记录数量 复制链接链接已复制到粘贴板!
1.6.1. 修改 Top 目录实体中显示记录的数量 复制链接链接已复制到粘贴板!
您可以修改 Top 目录实体卡中显示的记录数。您可以选择以下显示的记录数:
- 前 3
- 前 5
- 前 10
- 前 20
默认情况下,会显示前三个查看的目录实体。
流程
- 进入 Administration → Adoption Insights,然后点击 3 行 旁边的 Down 箭头,以更改显示的记录的数量。
1.6.2. 修改 Top 3 模板中的显示记录数 复制链接链接已复制到粘贴板!
您可以修改 Top 3 模板卡中显示的记录数。您可以选择以下显示的记录数:
- 前 3
- 前 5
- 前 10
- 前 20
默认情况下会显示前三个查看的模板。
流程
- 进入 Administration → Adoption Insights,然后点击 3 行 旁边的 Down 箭头,以更改显示的记录的数量。
1.6.3. 修改 Top 3 swig 中显示的记录数 复制链接链接已复制到粘贴板!
您可以修改 Top 3 xdg 卡中显示的记录数。您可以选择以下显示的记录数:
- 前 3
- 前 5
- 前 10
- 前 20
默认情况下,会显示前三个查看的 TechDocs。
流程
- 进入 Administration → Adoption Insights,然后点击 3 行 旁边的 Down 箭头,以更改显示的记录的数量。
1.6.4. 修改 Top 3 插件中的显示记录数 复制链接链接已复制到粘贴板!
您可以修改 Top 3 插件卡中显示的记录数。您可以选择以下显示的记录数:
- 前 3
- 前 5
- 前 10
- 前 20
默认情况下会显示前三个查看插件。
流程
- 进入 Administration → Adoption Insights,然后点击 3 行 旁边的 Down 箭头,以更改显示的记录的数量。
1.7. 过滤记录以在顶级目录实体中显示特定目录实体 复制链接链接已复制到粘贴板!
您可以使用标题中的下拉菜单过滤器,对任何项目显示进行过滤。默认情况下,Top 目录实体 卡显示 Developer Hub 实例中的所有项目。
流程
要查看表中的特定目录实体,请完成以下步骤:
- 前往 Administration → Adoption Insights,点 顶级目录实体 卡上的下拉菜单过滤器,然后选择您要查看的项目。
1.8. 查看搜索 复制链接链接已复制到粘贴板!
在搜索 卡中,您可以查看以下数据:
- 以图形形式,随着时间的推移视觉化门户搜索和趋势的数量
- 在卡标题中显示周期总数
- 根据所选的时间段,每个小时/星期/week/month 平均数量