{{< details >}}

  • Tier: 专业版, 旗舰版
  • Offering: JihuLab.com,私有化部署

{{< /details >}}

极狐GitLab 提供了许多优秀的报告工具,例如合并请求单元测试报告代码质量和性能测试。虽然 JUnit 是一个用于测试”通过”或”失败”的优秀开源框架,但查看给定变更的其他类型指标也很重要。

你可以配置你的作业以使用自定义指标报告,极狐GitLab 在合并请求中显示报告,以便更容易、更快速地识别变更,而不必检查整个日志。

Metrics Reports

用例

请考虑以下可以使用指标报告的数据示例:

  1. 内存使用
  2. 负载测试结果
  3. 代码复杂度
  4. 代码覆盖率统计

工作原理

分支的指标从最新的指标报告产物(默认文件名:metrics.txt)中读取为字符串值。

对于 MR,这些指标的值从功能分支与目标分支的值进行比较。然后它们按以下顺序显示在 MR 小部件中:

  • 现有指标的值已更改。
  • MR 添加的指标。标记为 徽章。
  • MR 移除的指标。标记为 已移除 徽章。
  • 现有指标的值未更改。

如何设置

添加一个创建指标报告的作业(默认文件名:metrics.txt)。该文件应符合 OpenMetrics 格式。

例如:

metrics:
  script:
    - echo 'metric_name metric_value' > metrics.txt
  artifacts:
    reports:
      metrics: metrics.txt

高级示例

来自 Prometheus 文档的 OpenMetrics 文本文件的高级示例呈现在合并请求小部件中,如下所示:

Metrics Reports Advanced

故障排除

指标报告未更改

在尝试查看合并请求中的指标报告时,你可能会看到”指标报告未更改”。原因如下:

  • 合并请求的目标分支没有用于比较的基准指标报告。
  • 你没有付费订阅。