パイプライントレースへのタグとメトリクスの追加

選択したサイト () では CI Visibility は利用できません。

カスタムタグとメトリクスはベータ版機能であり、API はまだ変更可能です。

カスタムタグとメトリクスコマンドは、CI Visibility パイプラインのトレースにユーザー定義のテキストや数値のタグを追加する方法を提供します。 これらのタグを使用して、ファセット (文字列値タグ) またはメジャー (数値タグ) を作成することができます。ファセットやメジャーは、パイプラインの検索、グラフ化、監視に使用することができます。

互換性

カスタムタグとメトリクスは、以下の CI プロバイダーで動作します。

  • Buildkite
  • CircleCI
  • GitLab (SaaS またはセルフホスト >= 14.1)
  • GitHub.com (SaaS) 注: GitHub の場合、タグとメトリクスはパイプラインスパンにのみ追加可能です。

Datadog CI CLI のインストール

npm を使用して datadog-ci (>=v1.15.0) CLI をグローバルにインストールします。

npm install -g @datadog/datadog-ci

また、npm を使いたくない場合は、ベータ版のスタンドアロンバイナリを使ってみることもできます。

Linux でスタンドアロンバイナリをインストールするには、以下を実行します。

curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_linux-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci

MacOS でスタンドアロンバイナリをインストールするには、以下を実行します。

curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_darwin-x64" --output "/usr/local/bin/datadog-ci" && chmod +x /usr/local/bin/datadog-ci

Windows でスタンドアロンバイナリをインストールするには、以下を実行します。

Invoke-WebRequest -Uri "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_win-x64.exe" -OutFile "datadog-ci.exe"

パイプライントレースへのタグの追加

タグは、パイプラインスパンまたはジョブスパンに追加することができます。これを行うには、以下を実行します。

datadog-ci tag [--level <pipeline|job>] [--tags <tags>]

環境変数 DATADOG_API_KEY を使用して、有効な Datadog API キーを指定する必要があります。

環境変数 DATADOG_SITE を使って Datadog サイトを指定する必要があります。

次の例では、パイプラインスパンに team というタグを追加しています。

datadog-ci tag --level pipeline --tags team:backend

次の例では、現在のジョブのスパンに go.version というタグを追加しています。

datadog-ci tag --level job --tags "go.version:`go version`"

タグからファセットを作成するには、パイプライン実行ページでタグ名の横にある歯車アイコンをクリックし、create facet (ファセットを作成する) オプションをクリックします。

パイプライントレースへのメトリクスの追加

パイプラインスパンやジョブスパンに数値タグを追加する場合は、以下を実行します。

datadog-ci metric [--level <pipeline|job>] [--metrics <metrics>]

環境変数 DATADOG_API_KEY を使用して、有効な Datadog API キーを指定する必要があります。

環境変数 DATADOG_SITE を使用して Datadog サイトを指定する必要があります。

次の例では、パイプラインスパンに error_rate というメトリクスを追加しています。

datadog-ci metric --level pipeline --metrics "error_rate:0.56"

次の例では、現在実行中のジョブのスパンに binary.size というメトリクスを追加しています。

datadog-ci metric --level job --metric "binary.size:`ls -l dst/binary | awk '{print \$5}' | tr -d '\n'`"

メジャーを作成するには、 パイプライン実行ページ でメトリクス名の横にある歯車アイコンをクリックし、create measure (メジャーを作成する) オプションをクリックします。

その他の参考資料

お役に立つドキュメント、リンクや記事: