Help us learn about your current experience with the documentation. Take the survey.

分析仪表板

  • 版本：Premium, Ultimate
  • 提供：GitLab.com, GitLab 自托管, GitLab 专用版

分析仪表板帮助您在内置仪表板上可视化收集的数据。

在 史诗 13801 中提出了增强的仪表板体验。

数据源

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

内置仪表板

为了帮助您开始使用分析，GitLab 提供了带有预定义可视化的内置仪表板。 这些仪表板标记为 由 GitLab 提供。 您无法编辑内置仪表板，但可以创建具有相似样式的自定义仪表板。

以下内置仪表板可用：

  • 价值流仪表板 显示与 DevOps 性能、安全暴露和工作流优化相关的指标。
  • AI 影响仪表板 显示 AI 工具对项目或组的软件开发生命周期（SDLC）指标的影响。

自定义仪表板

您可以 创建自定义仪表板 来可视化与您案例最相关的指标。

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

项目维护者可以使用 代码所有者 和 审批规则 等功能对仪表板更改强制执行审批规则。 您的仪表板文件与项目的其余代码一起在源代码控制中进行版本控制。

查看项目仪表板

先决条件：

  • 您必须至少拥有项目的 Reporter 角色。

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

  1. 在左侧边栏，选择 搜索或转到 并找到您的项目。
  2. 选择 分析 > 分析仪表板。
  3. 从可用仪表板列表中，选择您要查看的仪表板。

查看群组仪表板

先决条件：

  • 您必须至少拥有群组的 Reporter 角色。

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

  1. 在左侧边栏，选择 搜索或转到 并找到您的群组。
  2. 选择 分析 > 分析仪表板。
  3. 从可用仪表板列表中，选择您要查看的仪表板。

更改仪表板位置

您可以更改项目或群组自定义仪表板的位置。

先决条件：

  • 您必须至少拥有项目所属的项目或群组的 Maintainer 角色。

群组仪表板

问题 411572 提议将此功能连接到群组级仪表板。

要更改群组自定义仪表板的位置：

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

项目仪表板

默认情况下，自定义仪表板保存到当前项目，因为 仪表板通常在获取分析数据的项目中定义。 但是，您也可以为仪表板使用单独的项目。 如果您要对仪表板定义强制执行特定的访问规则或跨多个项目共享仪表板，则推荐此设置。

您只能在位于同一群组的项目之间共享仪表板。

要更改项目仪表板的位置：

  1. 在左侧边栏，选择 搜索或转到 并找到您的项目， 或选择 新建 ( plus ) 和 新建项目/仓库 来创建存储仪表板文件的项目。
  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 schema。

  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

仪表板过滤器

仪表板支持以下过滤器：

  • 日期范围：日期选择器，用于按日期过滤数据。
  • 匿名用户：切换开关，用于包含或排除数据集中的匿名用户。

要启用过滤器，在 .yaml 配置文件中将过滤器的 enabled 选项设置为 true：

title: 我的仪表板
# ...
filters:
  excludeAnonymousUsers:
    enabled: true
  dateRange:
    enabled: true

查看完整的 仪表板配置示例。

定义内联图表可视化

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

  • 折线图，选项列在 ECharts 文档 中。

  • 柱状图，选项列在 ECharts 文档 中。

  • 数据表。

  • 单个统计值，唯一选项是设置 decimalPlaces（数字，默认值为 0）。 此过程也可以用于用户创建的仪表板。每个可视化必须使用以下 必需字段编写：

  • version

  • type

  • data

  • options

定义图表可视化模板

我们建议谨慎使用可视化模板。如果不加以管理，可视化模板可能导致仪表板编辑器 UI 中出现很长的可视化 选择列表，这可能导致可视化被遗漏或重复。通常，可视化模板应保留用于将在多个仪表板中 相同使用的可视化。

如果您需要多个仪表板使用相同的可视化，可以将其存储为单独的模板文件。 添加到仪表板时，可视化模板将被复制到仪表板中。复制到仪表板的可视化模板 在可视化模板更新时不会更新。

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

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

对于 示例，要创建一个显示事件随时间变化的折线图，在 visualizations 文件夹中 创建一个 line_chart.yaml 文件，包含以下必需字段：

  • version
  • type
  • data
  • options

故障排除

加载仪表板时出现错误。

如果仪表板显示无法加载数据的全局错误消息，请先尝试重新加载页面。 如果错误仍然存在：

  • 检查您的配置是否与 ee/app/validators/json_schemas/analytics_dashboard.json 中定义的仪表板 JSON schema 匹配。

无效的仪表板配置

如果仪表板显示配置无效的全局错误消息，请检查您的配置是否与 ee/app/validators/json_schemas/analytics_dashboard.json 中定义的仪表板 JSON schema 匹配。

无效的可视化配置

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

仪表板面板错误

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

  • 确保您的 可视化 配置设置正确。