正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

CI/CDパイプラインのテレメトリを可観測性として表示

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed
  • ステータス: 実験的機能

有効にすると、GitLab可観測性はCI/CDパイプラインを自動的に計測し、コードを変更することなく、パイプラインのパフォーマンス、ジョブの実行時間、実行フローの表示レベルを提供します。

  • どのジョブがパイプラインを遅くしているかの表示レベル。
  • パイプラインのパフォーマンスが時間の経過とともにどのように変化するか。
  • お使いのデプロイプロセスにおけるボトルネック。

パイプラインの計測を有効にする

自動パイプライン計測を有効にするには、GITLAB_OBSERVABILITY_EXPORT CI/CD変数をプロジェクトまたはグループに追加します:

  1. 上部のバーで、検索または移動先を選択して、プロジェクトまたはグループを見つけます。
  2. 左サイドバーで、設定 > CI/CDを選択します。
  3. 変数を展開します。
  4. 変数を追加を選択します。
  5. 変数を設定します:
    • キー: GITLAB_OBSERVABILITY_EXPORT
    • : tracesmetricslogsのうち1つ以上 (複数の値を指定する場合はカンマ区切り)
    • タイプ: 変数
    • 環境範囲: すべて (または特定の環境)
  6. 変数を追加を選択します。

計測の種類

GITLAB_OBSERVABILITY_EXPORT変数は次の値を受け入れます:

  • traces: パイプラインの実行フロー、ジョブの依存関係、およびタイミングを示す分散トレースをエクスポートする
  • metrics: パイプラインの期間、ジョブの成功率、およびリソース使用量に関するメトリクスをエクスポートする
  • logs: パイプラインの実行からの構造化ログをエクスポートする

複数の種類をカンマで区切って有効にできます:

traces,metrics,logs

仕組み

変数が設定されると、GitLabは自動的に以下を実行します:

  1. 各パイプラインが完了した後、パイプラインの実行データをキャプチャします
  2. データを設定に基づいてOpenTelemetry形式に変換します
  3. テレメトリデータをGitLab可観測性インスタンスにエクスポートする
  4. データを可観測性ダッシュボードで利用できるようにします

お使いの.gitlab-ci.ymlファイルへの変更は必要ありません。計測はバックグラウンドで自動的に行われます。

パイプラインのテレメトリを表示

計測が有効なパイプラインを実行した後:

  1. 上部のバーで、検索または移動先を選択して、グループを見つけます。
  2. 左サイドバーで、可観測性 > サービスを選択します。
  3. gitlab-ciサービスを選択して、パイプライン実行からのトレース、メトリクス、およびログを表示します。

GitLab Observability TemplatesからのCI/CDダッシュボードテンプレートは、パイプラインのパフォーマンス分析のための事前構築済み視覚化を提供します。