選択したサイト () では CI Visibility は利用できません。
カスタムコマンドは、CI パイプラインの個々のコマンドをトレースする方法を提供し、ジョブが持つかもしれないセットアップやティアダウンアクション (例えば、Docker イメージのダウンロードや Kubernetes ベースのインフラで利用できるノードの待機) を考慮せずにコマンドにかかる時間を測定することを可能にします。これらのスパンは、パイプラインのトレースの一部として表示されます。
互換性
カスタムコマンドは、以下の CI プロバイダーで動作します。
- Jenkins と Datadog プラグイン >= v3.2.0
- CircleCI
Datadog CI CLI のインストール
npm
を使用して datadog-ci
(>=v0.17.0) CLI をグローバルにインストールします。
npm install -g @datadog/datadog-ci
コマンドのトレース
コマンドをトレースするには、以下を実行します。
datadog-ci trace [--name <name>] -- <command>
環境変数 DATADOG_API_KEY
に有効な Datadog API キーを指定します。例:
DATADOG_API_KEY=<key> DATADOG_SITE= datadog-ci trace \
--name "Greet" \
-- \
echo "Hello World"
選択したサイト () では CI Visibility は利用できません。
コンフィギュレーション設定
これらのオプションは datadog-ci trace
コマンドで利用可能です。
--name
- カスタムコマンドの表示名。
デフォルト: <command>
と同じ値
例: Wait for DB to be reachable
--tags
- カスタムコマンドにアタッチされる
key:value
形式のキーと値のペア (--tags
パラメーターは複数回指定できます)。DD_TAGS
を使用してタグを指定する場合は、カンマを使用してタグを区切ります (例: team:backend,priority:high
)。
環境変数: DD_TAGS
デフォルト: (none)
例: team:backend
注: --tags
と DD_TAGS
環境変数を使用して指定されたタグがマージされます。--tags
と DD_TAGS
の両方に同じキーが表示される場合、環境変数 DD_TAGS
の値が優先されます。 --no-fail
- サポートされていない CI プロバイダーで実行しても、datadog-ci が失敗しないようにします。この場合、コマンドは実行されますが、Datadog には何も報告されません。
デフォルト: false
- 位置引数
- 起動され、トレースされるコマンド。
次の環境変数がサポートされています。
DATADOG_API_KEY
(必須)- リクエストの認証に使用される Datadog API キー。
デフォルト: (なし)
さらに、選択したサイトを使用するように Datadog サイトを構成します ():
DATADOG_SITE
- 結果をアップロードする Datadog サイト。
デフォルト: datadoghq.com
選択したサイト:
その他の参考資料