分析仪表盘（实验）

  • 引入于 15.9 版本，作为实验功能，功能标志为 combined_analytics_dashboards。默认禁用。
  • combined_analytics_dashboards 在极狐GitLab 16.11 版本中默认启用。
  • combined_analytics_dashboards 在极狐GitLab 17.1 中被移除。

分析仪表盘能够帮助您可视化收集到的数据。您可以使用极狐GitLab 内置的仪表盘或使用自定义可视化功能创建自己的仪表盘。

数据源

数据源是与数据库或数据集合的连接，仪表盘过滤器和可视化分析可以使用它来查询和检索结果。

分析表盘使用如下数据源：

您还可以添加自定义可视化数据源。

内置仪表盘

为了帮助您使用分析，极狐GitLab 提供了内置仪表盘，其中包含预定义的可视化。这些仪表盘标记为 By GitLab。您不能编辑内置仪表盘，但您可以创建具有类似样式的自定义仪表盘。

产品分析仪表盘

当启用生产分析后，以下内置仪表盘可用：

  • 受众 显示与流量相关的指标，例如用户和会话的数量。
  • 行为 显示与用户活动相关的指标，例如页面浏览量和事件数量。

价值流管理仪表盘

自定义仪表盘

使用自定义仪表盘来设计和创建与您的用例最相关的指标的可视化。您可以使用仪表盘设计器创建自定义仪表盘。

  • 每个项目可以有无限数量的仪表盘。可能的唯一限制是存储库大小限制。
  • 每个仪表盘可以引用一个或多个可视化。
  • 可视化在仪表盘之间共享。

项目维护者可以使用诸如代码所有者和审批规则等特性对仪表板更改进行强制审批。您的仪表板文件与项目的其余代码一起存储在源代码控制中。

仪表盘设计器

  • 引入于极狐GitLab 16.1，使用名为 combined_analytics_dashboards_editor 的功能标志。默认禁用。
  • 在极狐GitLab 16.6 中 GA。功能标志 combined_analytics_dashboards_editor 被移除。

您可以使用仪表盘设计器来：

可视化设计器

  • 引入于极狐GitLab 16.4，使用名为 combined_analytics_visualization_editor 的功能标志。默认禁用。
  • 在极狐GitLab 16.7 中 GA。功能标志 group_analytics_dashboards 被移除。
note 此功能仅和产品分析数据源兼容。

您可以使用可视化设计器来：

查看项目仪表盘

先决条件：

  • 您必须至少具有项目的报告者角色。

要查看项目的仪表盘（包括内置和自定义仪表盘）列表：

  1. 在左侧导航栏，选择 搜索或前往 并找到您的项目。
  2. 选择 分析 > 分析仪表盘。
  3. 从可用的仪表盘列表，选择您想要查看的仪表盘。

查看群组仪表盘

  • 引入于极狐GitLab 16.2，使用名为 group_analytics_dashboards 的功能标志。默认禁用。
  • 在极狐GitLab 16.8 中 GA。
  • 功能标志 group_analytics_dashboards 在极狐GitLab 16.11 中被移除。

先决条件：

  • 您必须至少具有群组的报告者角色。

要查看群组的仪表盘（包括内置和自定义仪表盘）列表：

  1. 在左侧导航栏，选择 搜索或前往 并找到您的群组。
  2. 选择 分析 > 分析仪表盘。
  3. 从可用的仪表盘列表，选择您想要查看的仪表盘。

查看价值流仪表盘

  • 引入于极狐GitLab 16.6，使用名为 group_analytics_dashboard_dynamic_vsd 的功能标志。默认禁用。
  • 在极狐GitLab 17.0 中 GA。
  • 功能标志 group_analytics_dashboard_dynamic_vsd 在极狐GitLab 17.0 中被移除。

要查看价值流仪表盘并将其作为群组的分析仪表盘：

  1. 在左侧导航栏，选择 搜索或前往 并找到您的群组。
  2. 选择 分析 > 分析仪表盘。
  3. 从可用的仪表盘列表，选择 价值流仪表盘。

修改仪表盘的位置

您可以修改项目或群组仪表盘的位置。

先决条件：

  • 您必须至少具有项目或项目所属群组的维护者角色。

群组仪表盘

要修改群组仪表盘的位置：

  1. 在导航栏左侧，选择 搜索或前往 并找到您想要存储仪表盘文件的项目。项目必须属于您要创建仪表盘的群组。
  2. 在导航栏左侧，选择 搜索或前往 并找到您的群组。
  3. 选择 设置 > 分析。
  4. 在 分析仪表盘 部分中，选择您的仪表盘文件项目。
  5. 选择 保存更改。

项目仪表盘

默认情况下，自定义仪表盘保存到当前项目，因为仪表盘通常是从检索分析数据的项目中检索的。然而，您也可以为仪表盘创建单独的项目。如果您想对仪表盘定义实施特定的访问规则或跨多个项目共享仪表盘，建议使用此设置。

note 你仅能够在同一个群组中的项目之间共享仪表盘。

要修改项目仪表盘的位置：

  1. 在导航栏左侧，选择 搜索或前往 并找到您的项目，或选择 创建新的 ( ) 并选择 新项目/存储库 以创建存储仪表盘文件的项目。
  2. 在左侧导航栏，选择 搜索或前往 并找到分析项目。
  3. 选择 设置 > 分析。
  4. 在 分析仪表板 部分中，选择您的仪表盘文件项目。
  5. 选择 保存更改。

定义仪表盘

要定义仪表盘：

  1. 在 .gitlab/analytics/dashboards/ 中，创建一个与仪表盘同名的目录。

    每个仪表盘都应该有自己的目录。

  2. 在新目录中，创建一个与目录同名的 .yaml 文件，例如 .gitlab/analytics/dashboards/my_dashboard/my_dashboard.yaml。

    这个文件包含仪表盘定义。它必须符合 ee/app/validators/json_schemas/analytics_dashboard.json 中定义的 JSON 模式。

  3. 可选。要创建新的可视化以添加到仪表盘，请参阅定义图表可视化。

例如，如果您想创建三个仪表板（转换漏斗、人口统计细分和北极星指标）以及一个可视化（线图），该可视化适用于所有仪表板，则文件结构如下：

.gitlab/analytics/dashboards
├── conversion_funnels
│  └── conversion_funnels.yaml
├── demographic_breakdown
│  └── demographic_breakdown.yaml
├── north_star_metrics
|  └── north_star_metrics.yaml
├── visualizations
│  └── example_line_chart.yaml

定义图表可视化

您可以定义不同的图表并为其中一些图表添加可视化选项，例如：

  • 折线图，选项列表在 ECharts 文档 中。
  • 柱状图，选项列表在 ECharts 文档 中。
  • 数据表。
  • 单个状态，唯一的选项是设置 decimalPlaces（数字，默认值为 0）。

要为您的仪表盘定义图表可视化：

  1. 在 .gitlab/analytics/dashboards/visualizations/ 目录中，创建一个 .yaml 文件。文件名称应描述它定义的可视化。
  2. 在 .yaml 文件中，根据 jh/app/validators/json_schemas/analytics_visualization.json 中的模式定义可视化配置。

比如，要在 visualizations 文件夹中创建一个能展示随时间变化的事件数量的折线图，需创建一个名为 line_chart.yaml 的文件，并包含以下必填字段：

  • 版本
  • 类型
  • 数据
  • 选项

创建自定义仪表盘

要创建自定义仪表盘：

  1. 在左侧导航栏，选择 搜素或前往 并找到你的项目。
  2. 选择 分析 > 分析仪表盘。
  3. 选择 新建仪表盘。
  4. 在 新建仪表盘 输入框中，输入仪表盘名称。
  5. 在右侧的 添加可视化 列表中，选择要添加到仪表盘的可视化。
  6. 可选。拖动或调整所选面板的大小。
  7. 选择 保存。

编辑自定义仪表盘

您可以编辑您自定义仪表盘的主题并在仪表板设计器中添加或调整可视化。

要编辑既有的自定义仪表盘：

  1. 在左侧导航栏，选择 搜素或前往 并找到你的项目。
  2. 选择 分析 > 分析仪表盘。
  3. 在可用仪表盘列表中，选择您要编辑的自定义仪表盘（没有 By GitLab 标签）。
  4. 选择 编辑。
  5. 可选。更改仪表盘的标题。
  6. 可选。在右侧的 添加可视化 列表中，选择其他可视化添加到仪表板。
  7. 可选。在仪表板中，选择一个面板并拖动或调整大小。
  8. 选择 保存。

创建自定义的可视化

要创建自定义的可视化：

  1. 在左侧导航栏，选择 搜素或前往 并找到你的项目。
  2. 选择 分析 > 分析仪表盘。
  3. 选择 可视化设计器。
  4. 在 可视化标题 输入框中，输入可视化名称。
  5. 从 可视化类型 下拉列表中，选择可视化类型。
  6. 在 您想可视化什么指标？ 部分，选择一个 衡量或维度。
  7. 选择 保存。

当您保存可视化后，您可以在同一个项目中将它添加到新的或现有的自定义仪表盘中。

可视化查询构建器

  • 引入于极狐GitLab 17，1，并使用名为 analytics_visualization_designer_filtering 的功能标志。默认情况下禁用。
  • 在极狐GitLab 17.2 中 GA。功能标志 analytics_visualization_designer_filtering 被移除。

您可以使用衡量和维度来过滤并重新定义自定义可视化结果：

  • 衡量：可以计算的属性。衡量默认按聚合。
  • 维度：与衡量相关的属性。您可以将多个维度添加到衡量中。

您可以使用以下度量值过滤自定义事件名称：

  • Tracked events count
  • Tracked events unique user count
note 当您修改或删除度量值时，可能也会删除依赖的维度。

故障排查

Something went wrong while loading the dashboard.

如果仪表盘显示了数据无法被加载的全局错误数据，首先尝试重新加载页面。如果错误持续：

  • 检查您的配置是否与 jh/app/validators/json_schemas/analytics_dashboard.json 中定义的仪表盘 JSON 模式匹配。
  • 对于产品分析，请确保您的管理员和项目设置 已正确设置。

Invalid dashboard configuration

如果仪表盘展示了配置无效的错误消息，请检查您的配置是否与 jh/app/validators/json_schemas/analytics_dashboard.json 中定义的仪表盘 JSON 模式匹配。

Invalid visualization configuration

如果仪表板面板显示了可视化配置无效的消息，请检查您的可视化配置是否与 jh/app/validators/json_schemas/analytics_visualization.json 中定义的可视化 JSON 模式匹配。

仪表盘面板错误

如果仪表盘面板展示错误消息：

  • 确保您的 Cube 查询和可视化配置是争取设置的。
  • 对于产品分析，也检查可视化 Cube 查询是否有效。