GitLab パイプラインでトレースを設定する

GitLab パイプラインでトレースを設定する

互換性

サポートされている GitLab バージョン:

  • GitLab.com (SaaS)
  • GitLab >= 14.1 (セルフホスト)

追加のコンフィギュレーションでサポートされているその他のバージョン:

  • GitLab >= 13.7.0 (セルフホスト)、datadog_ci_integration 機能フラグを有効にします。

Datadog インテグレーションの構成

インスツルメントするプロジェクトまたはグループごとに、Settings > Integrations > Datadog に移動して、プロジェクトまたはグループのインテグレーションを構成します。

インスツルメントするプロジェクトまたはグループごとに、Settings > Integrations > Datadog に移動して、プロジェクトまたはグループのインテグレーションを構成します。

Admin > Settings > Integrations > Datadog に移動して、GitLab インスタンスレベルでインテグレーションをアクティブ化することもできます。

datadog_ci_integration 機能フラグを有効にして、インテグレーションをアクティブ化します。インストールの種類に応じて、GitLab の Rails Runner を使用する次のコマンドのいずれかを実行します。

Omnibus インストール

sudo gitlab-rails runner "Feature.enable(:datadog_ci_integration)"

ソースインストールから

sudo -u git -H bundle exec rails runner \
  -e production \
  "Feature.enable(:datadog_ci_integration)"

Kubernetes インストール

kubectl exec -it <task-runner-pod-name> -- \
  /srv/gitlab/bin/rails runner "Feature.enable(:datadog_ci_integration)"

次に、インスツルメントするプロジェクトごとに Settings > Integrations > Datadog に移動して、プロジェクトでインテグレーションを構成します。

: GitLab の初期バージョンのバグにより、GitLab の UI でオプションが使用可能であっても、GitLab バージョン 14.1 未満ではグループまたはインスタンスレベルで Datadog インテグレーションを有効にできません。

インテグレーションコンフィギュレーション設定を入力します。

Active
インテグレーションを有効にします。
Datadog site
データを送信する Datadog サイトを指定します。
デフォルト: datadoghq.com
選択したサイト:
可能な値: datadoghq.comdatadoghq.eu
API URL (オプション)
データを直接送信するために使用される API URL をオーバーライドできます。これは、高度なシナリオでのみ使用されます。
デフォルト: (空、オーバーライドなし)
API key
データを送信するときに使用する API キーを指定します。Datadog の Integrations セクションの APIs タブで生成できます。
Service (オプション)
インテグレーションによって生成された各スパンにアタッチするサービス名を指定します。これを使用して、GitLab インスタンスを区別します。
デフォルト: gitlab-ci
Env (オプション)
インテグレーションによって生成された各スパンに接続する環境 (env タグ) を指定します。これを使用して、GitLab インスタンスのグループを区別します (例: ステージングまたは本番)。
デフォルト: none

Test settings ボタンを使用してインテグレーションをテストできます (プロジェクトでインテグレーションを構成する場合にのみ使用できます)。成功したら、Save changes をクリックしてインテグレーションのセットアップを完了します。

Webhook を介したインテグレーション

ネイティブの Datadog インテグレーションを使用する代わりに、Webhook を使用してパイプラインデータを Datadog に送信できます。

: ネイティブの Datadog インテグレーションは、推奨されるアプローチであり、積極的に開発中のオプションです。

リポジトリ (または GitLab インスタンス設定) の Settings > Webhooks に移動し、新しい Webhook を追加します。

  • URL: https://webhook-intake.datadoghq.com/api/v2/webhook/?dd-api-key=<API_KEY> ここで、<API_KEY>Datadog API キーです。
  • Secret Token: 空白のままにします
  • Trigger: Job eventsPipeline events を選択します。

  • URL: https://webhook-intake.datadoghq.eu/api/v2/webhook/?dd-api-key=<API_KEY> ここで、<API_KEY>Datadog API キーです。
  • Secret Token: 空白のままにします
  • Trigger: Job eventsPipeline events を選択します。

カスタムの env または service パラメーターを設定するには、Webhook の URL で他のクエリパラメーターを追加します: &env=<YOUR_ENV>&service=<YOUR_SERVICE_NAME>

Datadog でパイプラインデータを視覚化する

インテグレーションが正常に構成されたら、パイプラインが終了した後、Pipelines ページと Pipeline Executions ページにデータが入力されます。

: Pipelines ページには、各リポジトリのデフォルトブランチのデータのみが表示されます。

その他の参考資料

選択した Datadog サイト () は、現時点ではサポートされていません。