メトリクスレポート

GitLabRunner 11.10以上が必要です。

概要

GitLab では、マージリクエストのための優れたレポートツール -JUnit レポート、コード品質、パフォーマンステストなど - をたくさん提供しています。JUnit は「合格」や「不合格」のテストを行うための優れたオープンフレームワークですが、ある変更から得られる他の種類のメトリクスを見ることも重要です。

カスタムメトリクスレポートを使用するようにジョブを設定することができ、GitLabはマージリクエストのレポートを表示するので、ログ全体をチェックすることなく変更をより簡単かつ迅速に特定することができます。

Metrics Reports

ユースケース

メトリクス・レポートを利用できるデータの例を以下に示します：

  1. メモリ使用量
  2. 負荷テスト結果
  3. コードの複雑さ
  4. コードカバレッジ統計

どのように動作するか

メトリクスは、メトリクス・レポート（デフォルト：metrics.txt）から読み込まれます。 メトリクスは解析され、MR ウィジェットに表示されます。

すべての値は文字列とみなされ、文字列の比較は、最新の利用可能なmetrics からのアーティファクトの違いを見つけるために使用されます：

  • master
  • フィーチャーブランチ

設定方法

メトリクス・レポートを作成するジョブを追加します (デフォルトのファイル名:metrics.txt)。ファイルはOpenMetricsフォーマットに準拠する必要があります。

使用例： 

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

高度な例

OpenMetrics テキストファイルの高度な例 (Prometheusドキュメントより) はマージリクエストウィジェットで次のように表示されます：

Metrics Reports Advanced