遥测数据收集和分析
收集和分析 Web 分析和系统可观察性数据以增强 Red Hat Developer Hub 体验
摘要
第 1 章 遥测数据收集和分析
遥测数据收集功能有助于收集和分析遥测数据,以提高您对 Red Hat Developer Hub 的经验。此功能默认为启用。
红帽收集并分析以下数据:
- Web 分析
Web 分析使用分段工具。它是跟踪用户行为和 Red Hat Developer Hub 的交互。具体来说,它跟踪以下内容:
- 页面访问的事件,然后单击链接或按钮。
- 系统相关信息,如区域设置、时区、用户代理,包括浏览器和操作系统详情。
- 页面相关信息,如标题、类别、扩展名称、URL、路径、引用和搜索参数。
-
匿名 IP 地址,记录为
0.0.0.0
。 - 匿名用户名哈希,这是唯一标识符,仅用于识别 RHDH 应用的唯一用户数量。
- 系统可观察性
System Observability 使用 OpenTelemetry 工具。它是对 RHDH 的性能跟踪。具体来说,它跟踪以下指标:
- 关键系统指标,如 CPU 使用量、内存用量和其他性能指标。
- 有关系统组件的信息,如区域设置、时区和用户代理(包括浏览器和操作系统的详情)。
- 跟踪和记录监控系统进程,允许您排除影响 RHDH 性能的潜在问题。
使用 RHDH,您可以根据您的需要自定义 Web 分析和 System Observability 配置。
第 2 章 在 RHDH 中禁用遥测数据收集
要禁用遥测数据收集,您必须使用 Helm Chart 或 Red Hat Developer Hub Operator 配置禁用 analytics-provider-segment
插件。
作为管理员,您可以根据您的需要禁用遥测数据收集功能。例如,在 air-gapped 环境中,您可以禁用此功能,以避免不必要的出站请求,影响 RHDH 应用程序的响应。如需了解更多详细信息,请参阅 RHDH 中的 禁用遥测数据收集 部分。
2.1. 使用 Operator 禁用遥测数据收集
您可以使用 Operator 禁用遥测数据收集功能。
先决条件
- 您已在 OpenShift Container Platform Web 控制台中以管理员身份登录。
- 已使用 Operator 在 OpenShift Container Platform 上安装 Red Hat Developer Hub。
流程
执行以下步骤之一:
-
如果您已创建了
dynamic-plugins-rhdh
ConfigMap 文件且没有配置analytics-provider-segment
插件,请将插件添加到插件列表中,并将其plugins.disabled
参数设置为true
。 -
如果您已创建了
dynamic-plugins-rhdh
ConfigMap 文件并配置了analytics-provider-segment
插件,请在插件列表中搜索插件并将其plugins.disabled
参数设置为true
。 如果您还没有创建 ConfigMap 文件,请使用以下 YAML 代码创建该文件:
kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: true
kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: true
Copy to Clipboard Copied!
-
如果您已创建了
将
dynamicPluginsConfigMapName
参数的值设置为Backstage
自定义资源中的dynamic-plugins-rhdh
配置映射的名称:# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
Copy to Clipboard Copied! - 保存配置更改。
2.2. 使用 Helm Chart 禁用遥测数据收集
您可以使用 Helm Chart 禁用遥测数据收集功能。
先决条件
- 您已在 OpenShift Container Platform Web 控制台中以管理员身份登录。
- 已使用 Helm Chart 在 OpenShift Container Platform 上安装 Red Hat Developer Hub。
流程
- 在 OpenShift Container Platform Web 控制台的 Developer 视角中,进入 Helm 视图来查看 Helm 发行版本列表。
点击您要使用的 Helm 发行版本上的 overflow 菜单,然后选择 Upgrade。
注意您还可以点 Create 按钮并编辑配置来禁用遥测,来创建新的 Helm 发行版本。
使用 Form view 或 YAML 视图来编辑 Helm 配置:
使用 Form view
- 展开 Root Schema → global → Dynamic plugins 配置。→ 应该在 backstage 应用中安装的动态插件列表。
- 点 backstage application 中的 Add list of dynamic plugins。
执行以下步骤之一:
如果您还没有配置插件,请在要安装的动态插件 Package 规格中添加以下值。它应该可以被 npm pack 命令使用。 字段:
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
-
如果您配置了插件,请找到要安装的动态插件的 Package 规格。它应该可以被 npm pack 命令使用。 字段带有
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
值。
- 选中 Disable the plugin 复选框。
- 单击 Upgrade。
使用 YAML 视图
执行以下步骤之一:
如果您还没有配置插件,请在
values.yaml
Helm 配置文件中添加以下 YAML 代码:# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: true # ...
# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: true # ...
Copy to Clipboard Copied! -
如果您配置了插件,请在 Helm 配置中搜索它,并将
plugins.disabled
参数的值设置为true
。
- 单击 Upgrade。
第 3 章 在 RHDH 中启用遥测数据收集
遥测数据收集功能默认为启用。但是,如果您禁用了这个功能并希望重新启用它,则必须使用 Helm Chart 或 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-rhdh
ConfigMap 文件且没有配置analytics-provider-segment
插件,请将插件添加到插件列表中,并将其plugins.disabled
参数设置为false
。 -
如果您已创建了
dynamic-plugins-rhdh
ConfigMap 文件并配置了analytics-provider-segment
插件,请在插件列表中搜索插件并将其plugins.disabled
参数设置为false
。 如果您还没有创建 ConfigMap 文件,请使用以下 YAML 代码创建该文件:
kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: false
kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: false
Copy to Clipboard Copied!
-
如果您已创建了
将
dynamicPluginsConfigMapName
参数的值设置为Backstage
自定义资源中的dynamic-plugins-rhdh
配置映射的名称:# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
Copy to Clipboard Copied! - 保存配置更改。
3.2. 使用 Helm Chart 启用遥测数据收集
您可以使用 Helm Chart 启用遥测数据收集功能。
先决条件
- 您已在 OpenShift Container Platform Web 控制台中以管理员身份登录。
- 已使用 Helm Chart 在 OpenShift Container Platform 上安装 Red Hat Developer Hub。
流程
- 在 OpenShift Container Platform Web 控制台的 Developer 视角中,进入 Helm 视图来查看 Helm 发行版本列表。
点击您要使用的 Helm 发行版本上的 overflow 菜单,然后选择 Upgrade。
注意您还可以点 Create 按钮并编辑配置来启用遥测(telemetry)来创建新的 Helm 发行版本。
使用 Form view 或 YAML 视图来编辑 Helm 配置:
使用 Form view
- 展开 Root Schema → global → Dynamic plugins 配置。→ 应该在 backstage 应用中安装的动态插件列表。
- 点 backstage application 中的 Add list of dynamic plugins。
执行以下步骤之一:
如果您还没有配置插件,请在要安装的动态插件 Package 规格中添加以下值。它应该可以被 npm pack 命令使用。 字段:
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
-
如果您配置了插件,请找到要安装的动态插件的 Package 规格。它应该可以被 npm pack 命令使用。 字段带有
./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
值。
- 清除 Disable the plugin 复选框。
- 单击 Upgrade。
使用 YAML 视图
执行以下步骤之一:
如果您还没有配置插件,请在 Helm 配置文件中添加以下 YAML 代码:
# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: false # ...
# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment' disabled: false # ...
Copy to Clipboard Copied! -
如果您配置了插件,请在 Helm 配置中搜索它,并将
plugins.disabled
参数的值设置为false
。
- 单击 Upgrade。
第 4 章 自定义分段源
analytics-provider-segment
插件默认向红帽发送收集的 Web 分析数据。但是,您可以配置一个新的 Segment 源,它根据您的需要接收 Web 分析数据。对于配置,您需要一个指向分段源的唯一分割写入键。
为您的应用程序用户创建自己的 Web 分析数据收集通知。
4.1. 使用 Operator 自定义分段源
您可以使用 Red Hat Developer Hub Operator 配置与 Segment 源的集成。
先决条件
- 您已在 OpenShift Container Platform Web 控制台中以管理员身份登录。
- 已使用 Operator 在 OpenShift Container Platform 上安装 Red Hat Developer Hub。
流程
在
Backstage
自定义资源(CR)中添加以下 YAML 代码:# ... spec: application: extraEnvs: envs: - name: SEGMENT_WRITE_KEY value: <segment_key> # ...
# ... spec: application: extraEnvs: envs: - name: SEGMENT_WRITE_KEY value: <segment_key>
1 # ...
Copy to Clipboard Copied! - 1
- 将
<segment_key
> 替换为您的分段源的唯一标识符。
- 保存配置更改。
4.2. 使用 Helm Chart 自定义分段源
您可以使用 Red Hat Developer Hub Helm Chart 配置与 Segment 源的集成。
先决条件
- 您已在 OpenShift Container Platform Web 控制台中以管理员身份登录。
- 已使用 Helm Chart 在 OpenShift Container Platform 上安装 Red Hat Developer Hub。
流程
- 在 OpenShift Container Platform Web 控制台的 Developer 视角中,进入 Helm 视图来查看 Helm 发行版本列表。
- 点击您要使用的 Helm 发行版本上的 overflow 菜单,然后选择 Upgrade。
使用 Form view 或 YAML 视图来编辑 Helm 配置:
使用 Form view
- 展开 Root Schema → Backstage Chart Schema → Backstage Parameters → Backstage container 环境变量。
- 单击 Add Backstage 容器环境变量 链接。
输入 Segment 键的名称和值。
- 单击 Upgrade。
使用 YAML 视图
在 Helm 配置文件中添加以下 YAML 代码:
# ... upstream: backstage: extraEnvVars: - name: SEGMENT_WRITE_KEY value: <segment_key> # ...
# ... upstream: backstage: extraEnvVars: - name: SEGMENT_WRITE_KEY value: <segment_key>
1 # ...
Copy to Clipboard Copied! - 1
- 将
<segment_key
> 替换为您的分段源的唯一标识符。
- 单击 Upgrade。
其他资源
- 要了解如何收集和分析同一组数据,请参阅 遥测数据收集。