コンテナ内のテスト

This product is not supported for your selected Datadog site. ().

概要

ビルド内で自分で起動したコンテナ内でテストを実行する場合 (たとえば、docker run または docker-compose を使用)、使用している CI プロバイダーに応じて以下の環境変数をコンテナに転送します。これにより、Datadog トレーサーによるビルド情報の自動検出が可能になります。

さらに、言語別のテストインスツルメンテーション手順に記載されているとおり、トレーサーの構成に必要な環境変数で渡す必要があります (DD_SERVICE、DD_ENV、およびコンテナ内からアクセス可能な、有効な DD_TRACE_AGENT_URL など)。

環境変数の管理

以下の表では、トレーサーを構成するために利用できる環境変数の一覧 (網羅的ではありません) を紹介しています。

    環境変数説明
    APPVEYORビルドが AppVeyor 環境で実行されているかどうかを示します。True (Ubuntu イメージの場合は true) に設定します。
    APPVEYOR_BUILD_IDAppVeyor ビルドの一意の識別子。
    APPVEYOR_BUILD_NUMBERAppVeyor によって割り当てられたビルド番号で、新しいビルドが作成されるたびにインクリメントされます。
    APPVEYOR_BUILD_FOLDERリポジトリがクローンされるディレクトリへのパス。
    APPVEYOR_REPO_PROVIDERgithub、bitbucket、kiln など、リポジトリのソース管理プロバイダーを指定します。
    APPVEYOR_REPO_NAMEowner-name/repo-name の形式で表現したリポジトリの名前。
    APPVEYOR_REPO_BRANCHビルド対象のリポジトリのブランチ。プル リクエストの場合は、PR のマージ先となるベース ブランチです。
    APPVEYOR_REPO_COMMIT現在のビルドのコミット ID (SHA)。
    APPVEYOR_REPO_TAG_NAMEタグによって開始されるビルドのタグ名。ビルドがタグによってトリガーされない場合、この変数は未定義となります。
    APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCHプル リクエストの送信元リポジトリのブランチ。
    APPVEYOR_REPO_COMMIT_MESSAGE現在のビルドに関連するコミット メッセージ。
    APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED最初の改行以降のテキストも含む拡張されたコミット メッセージ。
    APPVEYOR_REPO_COMMIT_AUTHORコミット作成者の名前。
    APPVEYOR_REPO_COMMIT_AUTHOR_EMAILコミット作成者のメールアドレス。

    AppVeyor がビルドごとに設定する環境変数の詳細な一覧については、AppVeyor の公式ドキュメントを参照してください。

    環境変数説明
    TF_BUILDビルドが Azure Pipelines で実行されていることを示しています。
    BUILD_DEFINITIONNAMEビルド パイプラインの名前。
    BUILD_BUILDID完了したビルドのレコードの ID。
    BUILD_SOURCESDIRECTORYソース コード ファイルがダウンロードされるエージェントのローカル パス。
    BUILD_REPOSITORY_URIトリガーするリポジトリの URL。
    BUILD_SOURCEBRANCHビルドがキューに入れられた、トリガーするリポジトリのブランチ。
    BUILD_SOURCEVERSIONこのビルドに含まれる、トリガーするリポジトリの最新のバージョン コントロールの変更。
    BUILD_SOURCEVERSIONMESSAGEトリガーするリポジトリのコミットまたは変更セットのコメント。
    BUILD_REQUESTEDFORIDビルドをトリガーしたユーザーの ID。
    BUILD_REQUESTEDFOREMAILビルドをトリガーしたユーザーのメール アドレス。
    SYSTEM_TEAMFOUNDATIONSERVERURITeam Foundation Server または Azure DevOps Services アカウントの URI。
    SYSTEM_TEAMPROJECTIDビルドが属するチーム プロジェクトの ID。
    SYSTEM_JOBID実行中のジョブの ID。
    SYSTEM_TASKINSTANCEIDジョブ内のタスク インスタンスの ID。
    SYSTEM_PULLREQUEST_SOURCEREPOSITORYURIプル リクエストの送信元リポジトリの URL。
    SYSTEM_PULLREQUEST_SOURCEBRANCHプル リクエストのソース ブランチ。
    SYSTEM_PULLREQUEST_SOURCECOMMITIDプル リクエストのソース ブランチのコミット ID。
    SYSTEM_STAGEDISPLAYNAMEパイプライン内のステージの表示名。
    SYSTEM_JOBDISPLAYNAMEパイプライン内のジョブの表示名。

    Azure DevOps Pipelines がビルドごとに設定する環境変数の詳細な一覧については、Azure の公式ドキュメントを参照してください。

    環境変数説明
    BITBUCKET_PIPELINE_UUIDパイプラインの UUID。
    BITBUCKET_BUILD_NUMBERビルドの一意の識別子。ビルドごとにインクリメントされ、一意のアーティファクト名を作成するために使用できます。
    BITBUCKET_CLONE_DIRDocker コンテナ内でリポジトリがクローンされるディレクトリの絶対パス。
    BITBUCKET_REPO_FULL_NAMEリポジトリのフル ネーム (http://bitbucket.org/ の後のすべての文字列)。
    BITBUCKET_GIT_SSH_ORIGINSSH の origin (例: [email protected]:/<workspace>/<repo>.git)。
    BITBUCKET_COMMITビルドを開始したコミットのハッシュ。
    BITBUCKET_BRANCHソース ブランチ。この値はブランチでのみ使用できます。タグに対するビルドやカスタム パイプラインでは使用できません。
    BITBUCKET_TAGビルドを開始したコミットのタグ。この値はタグでのみ使用できます。ブランチに対するビルドでは使用できません。

    Bitbucket がビルドごとに設定する環境変数の詳細な一覧については、Bitbucket の公式ドキュメントを参照してください。

    環境変数説明
    BITRISE_BUILD_SLUGbitrise.io 上でビルドを一意に識別するスラッグ。ビルド URL の一部です。
    BITRISE_TRIGGERED_WORKFLOW_IDトリガーされたワークフローの ID で、ワークフローが手動でトリガーされたか自動でトリガーされたかに関係なく公開されます。
    BITRISE_BUILD_NUMBERbitrise.io 上のビルド番号。
    BITRISE_BUILD_URLbitrise.io 上のビルドの URL。
    BITRISE_SOURCE_DIRベースとなる作業ディレクトリへのパス。デフォルトでは、別の値を指定しない限り、Bitrise が実行されるディレクトリになります。
    GIT_REPOSITORY_URLアプリをホストしている Git リポジトリの URL。
    BITRISE_GIT_COMMITビルドをトリガーした Git コミットのハッシュ (該当する場合)。
    GIT_CLONE_COMMIT_HASHビルドが使用するコミット (クローンされたコミット) のハッシュ。
    BITRISEIO_GIT_BRANCH_DESTビルドをトリガーしたプル リクエストの宛先ブランチまたはターゲット ブランチ。プル リクエストでトリガーされたビルドでのみ使用します。
    BITRISE_GIT_BRANCHBitrise によってビルドされる Git ブランチ (例: main)。
    BITRISE_GIT_TAGビルドが Git タグによってトリガーされる場合、この環境変数には使用されたタグが格納されます。
    BITRISE_GIT_MESSAGEコミット メッセージ、プル リクエストのタイトル、または手動でビルドをトリガーした場合に指定したメッセージ。
    BITRISE_APP_TITLEbitrise.io 上でのアプリのタイトル。
    GIT_CLONE_COMMIT_MESSAGE_SUBJECTクローンされたコミットのコミット メッセージの件名。
    GIT_CLONE_COMMIT_MESSAGE_BODYクローンされたコミットのコミット メッセージの本文 (内容)。
    GIT_CLONE_COMMIT_AUTHOR_NAMEクローンされたコミットの作成者名。
    GIT_CLONE_COMMIT_AUTHOR_EMAILクローンされたコミットの作成者のメール アドレス。
    GIT_CLONE_COMMIT_COMMITER_NAMEクローンされたコミットのコミッターの名前。
    GIT_CLONE_COMMIT_COMMITER_EMAILクローンされたコミットのコミッターのメール アドレス。

    Bitrise がビルドごとに設定する環境変数の詳細な一覧については、Bitrise の公式ドキュメントを参照してください。

    環境変数説明
    BUILDKITE常に true。
    BUILDKITE_PIPELINE_SLUGBuildkite 上でパイプラインを識別するスラッグ (URLで使用)。
    BUILDKITE_JOB_IDBuildkite がこのジョブに使用する内部 UUID。
    BUILDKITE_BUILD_IDビルドの UUID。
    BUILDKITE_BUILD_NUMBERビルド番号。この番号はビルドごとに増加し、各パイプライン内で一意となります。
    BUILDKITE_BUILD_URLBuildkite 上でのこのビルドの URL。
    BUILDKITE_BUILD_CHECKOUT_PATHエージェントがこのビルド用のコードをチェックアウトしたパス。
    BUILDKITE_REPOパイプラインのリポジトリ。
    BUILDKITE_COMMITビルドの Git コミット オブジェクト。
    BUILDKITE_BRANCHビルドされるブランチ。
    BUILDKITE_TAGビルドされるタグの名前 (このビルドがタグからトリガーされた場合)。
    BUILDKITE_MESSAGEビルドに関連付けられたメッセージ (通常はコミット メッセージ)。
    BUILDKITE_BUILD_AUTHORビルドされるコミットを作成したユーザーの名前。
    BUILDKITE_BUILD_AUTHOR_EMAILビルドされるコミットを作成したユーザーの通知用メール アドレス。
    BUILDKITE_BUILD_CREATORビルドを作成したユーザーの名前。
    BUILDKITE_BUILD_CREATOR_EMAILビルドを作成したユーザーの通知用メール アドレス。
    BUILDKITE_AGENT_IDエージェントの UUID。
    BUILDKITE_AGENT_META_DATA_*各エージェント タグの値。タグ名は変数名の末尾に付加されます。

    Buildkite がビルドごとに設定する環境変数の詳細な一覧については、Buildkite の公式ドキュメントを参照してください。

    環境変数説明
    CIRCLECIビルドが CircleCI で実行されているかどうかを示します。常に true に設定します。
    CIRCLE_PROJECT_REPONAMEビルドされるリポジトリの名前。
    CIRCLE_BUILD_NUM現在のジョブ番号。ジョブ番号はジョブごとに一意です。
    CIRCLE_BUILD_URLCircleCI 上での現在のジョブの URL。
    CIRCLE_WORKFLOW_ID現在のジョブのワークフロー インスタンスの一意の識別子。
    CIRCLE_WORKING_DIRECTORYコードがチェックアウトされる作業ディレクトリへのパス。
    CIRCLE_REPOSITORY_URLビルドされるリポジトリの URL。
    CIRCLE_SHA1現在のビルドで使用されるコミットの SHA1 ハッシュ。
    CIRCLE_BRANCHビルド対象のリポジトリのブランチ。
    CIRCLE_TAG現在のビルドがタグによってトリガーされる場合はタグ名。そうでない場合は空になります。
    CIRCLE_JOB現在のジョブの名前。

    CircleCI がビルドごとに設定する環境変数の詳細な一覧については、CircleCI の公式ドキュメントを参照してください。

    環境変数説明
    CF_BUILD_IDビルドの一意の識別子。
    CF_PIPELINE_NAMEパイプラインのフル パス (パイプラインが割り当てられているプロジェクトがあれば、そのプロジェクトも含む)。
    CF_BUILD_URLCodefresh 上のビルドの URL。
    CF_STEP_NAMEステップの名前 (例: 「MyUnitTests」)。
    CF_BRANCH実行時のメイン パイプラインに関連付けられている Git リポジトリのブランチ名またはタグ。
    CF_REVISION実行時におけるメイン パイプラインの Git リポジトリのリビジョン。

    Codefresh がビルドごとに設定する環境変数の詳細な一覧については、Codefresh の公式ドキュメントを参照してください。

    環境変数説明
    GITHUB_ACTION現在実行中のアクションの名前、またはステップの ID。例: repo-owner_name-of-action-repo。
    GITHUB_SERVER_URLGitHub サーバーの URL。例: https://github.com
    GITHUB_RUN_IDリポジトリ内で実行される各ワークフローに固有の番号。例: 1658821493。
    GITHUB_RUN_NUMBERリポジトリ内の特定のワークフローの各実行に固有の番号。例: 3。
    GITHUB_RUN_ATTEMPT特定のワークフローの実行に対する試行ごとに振られる固有の番号。例: 3。
    GITHUB_WORKFLOWワークフローの名前。例: My test workflow。
    GITHUB_WORKSPACEステップを実行するランナーのデフォルトの作業ディレクトリ。例: /home/runner/work/my-repo-name/my-repo-name。
    GITHUB_REPOSITORYオーナーおよびリポジトリ名。例: octocat/Hello-World。
    GITHUB_SHAワークフローをトリガーしたコミットの SHA。例: ffac537e6cbbf934b08745a378932722df287a53。
    GITHUB_HEAD_REFプル リクエストの head ref またはソース ブランチ (pull_request または pull_request_target イベントに対してのみ設定)。例: feature-branch-1。
    GITHUB_REFワークフローをトリガーしたブランチまたはタグの完全な形式の参照名。例: refs/heads/feature-branch-1。
    GITHUB_JOB現在のジョブ ID。例: greeting_job。

    GitHub Actions がビルドごとに設定する環境変数の詳細な一覧については、GitHub の公式ドキュメントを参照してください。

    環境変数説明
    GITLAB_CICI/CD で実行されるすべてのジョブで利用できます。利用可能な場合は true になります。
    CI_PIPELINE_ID現在のパイプラインのインスタンス レベルの ID。この ID は、GitLab インスタンス上のすべてのプロジェクトで一意です。
    CI_PIPELINE_URLパイプラインの詳細の URL。
    CI_PIPELINE_IID現在のパイプラインのプロジェクト レベルの IID (内部 ID)。現在のプロジェクト内でのみ一意となります。
    CI_PROJECT_PATHプロジェクト名を含むプロジェクトのネーム スペース。
    CI_PROJECT_DIRリポジトリがクローンされ、ジョブが実行されるディレクトリのフル パス。
    CI_JOB_STAGEジョブのステージ名。
    CI_JOB_NAMEジョブの名前。
    CI_JOB_URLジョブの詳細の URL。
    CI_JOB_IDジョブの内部 ID で、GitLab インスタンス内のすべてのジョブで一意です。
    CI_RUNNER_ID使用されるランナーの一意の ID。
    CI_RUNNER_TAGSランナー タグのカンマ区切りのリスト。
    CI_REPOSITORY_URLCI/CD ジョブ トークンを使用してリポジトリを Git clone (HTTP) するためのフル パス。
    CI_COMMIT_SHAプロジェクトのビルドの対象となるコミットのリビジョン。
    CI_COMMIT_REF_NAMEプロジェクトのビルドの対象となるブランチ名またはタグ名。
    CI_COMMIT_BRANCHコミットのブランチ名。ブランチ パイプラインでのみ利用できます。
    CI_COMMIT_TAGコミットのタグ名。タグのパイプラインでのみ使用できます。
    CI_COMMIT_AUTHORコミットの作成者 (Name 形式で表現)。
    CI_COMMIT_MESSAGEコミット メッセージの全文。
    CI_COMMIT_TIMESTAMPISO 8601 形式で表現されたコミットのタイム スタンプ。例: 2022-01-31T16:47:55Z。デフォルトは UTC。

    GitLab CI がビルドごとに設定する環境変数の詳細な一覧については、GitLab の公式ドキュメントを参照してください。

    環境変数説明
    JENKINS_URLビルドを実行している Jenkins マスターの URL。
    BUILD_TAG識別を容易にする jenkins-${JOB_NAME}-${BUILD_NUMBER} という形式の文字列。
    BUILD_NUMBER現在のビルド番号 (例: 153)。
    BUILD_URLこのビルドの結果を確認できる URL (例: http://buildserver/jenkins/job/MyJobName/666/)。
    WORKSPACEワーク スペースの絶対パス。
    JOB_NAMEビルドが属するプロジェクトの名前。
    JOB_URLジョブの詳細の URL。
    GIT_URLリポジトリに対して使用される Git URL ([email protected]:user/repo.git や https://github.com/user/repo.git など)。
    GIT_URL_1複数のリポジトリが構成されている場合は、最初の Git リポジトリの URL。
    GIT_COMMITビルド用にチェックアウトしたコミットの Git ハッシュ。
    GIT_BRANCHビルド用にチェックアウトされた Git ブランチ。
    NODE_NAMEビルドが実行されているノードの名前。マスター ノードの場合は ‘master’ に等しくなります。
    NODE_LABELSノードに割り当てられたラベルのカンマ区切りのリスト。
    DD_CUSTOM_TRACE_IDトレース ID 用に Jenkins Datadog プラグインによって設定されるカスタム変数。
    DD_CUSTOM_PARENT_ID親 ID 用に Jenkins Datadog プラグインによって設定されるカスタム変数。

    Jenkins がビルドごとに設定する環境変数の詳細な一覧については、Jenkins の公式ドキュメントを参照してください。

    環境変数説明
    TEAMCITY_VERSIONTeamCity サーバーのバージョン。
    TEAMCITY_BUILDCONF_NAME現在のビルドが属するビルド構成の名前。
    BUILD_URL現在のビルドへのリンク。
    DATADOG_BUILD_IDDatadog TeamCity インテグレーション によって設定されるカスタム変数。

    TeamCity がビルドごとに設定する環境変数の詳細な一覧については、TeamCity の公式ドキュメントを参照してください。

    環境変数説明
    TRAVISビルドが Travis CI 上で実行されていることを示すために、常に true に設定します。
    TRAVIS_BUILD_IDTravis CI が内部的に使用する現在のビルドの ID。
    TRAVIS_BUILD_NUMBER現在のビルド番号。例: 4。
    TRAVIS_BUILD_WEB_URLビルド ログへの URL。
    TRAVIS_BUILD_DIRビルド中のリポジトリがコピーされたワーカー上のディレクトリへの絶対パス。
    TRAVIS_JOB_WEB_URLジョブ ログへの URL。
    TRAVIS_REPO_SLUG現在ビルド中のリポジトリのスラッグ (形式: owner_name/repo_name)。
    TRAVIS_COMMIT現在のビルドがテストしているコミット。
    TRAVIS_BRANCHプッシュ ビルドの場合は、ブランチの名前。PR ビルドの場合は、PR の対象となるブランチの名前。
    TRAVIS_TAG現在のビルドが Git タグを対象としている場合、この変数にはタグ名が設定されます。そうでない場合は空になります。
    TRAVIS_PULL_REQUEST_SLUG現在のジョブがプル リクエストの場合、PR の作成元となったリポジトリのスラッグ。
    TRAVIS_PULL_REQUEST_BRANCH現在のジョブがプル リクエストの場合、PR の作成元となったブランチの名前。
    TRAVIS_COMMIT_MESSAGEコミット メッセージの件名と本文 (折り返しなし)。

    Travis CI がビルドごとに設定する環境変数の詳細な一覧については、Travis CI の公式ドキュメントを参照してください。

    環境変数説明
    BUDDY現在の環境が Buddy 環境かどうかを表します。例: true。
    BUDDY_SCM_URLプロジェクトと同期しているリポジトリの URL。例: https://github.com/githubaccount/repository
    BUDDY_EXECUTION_REVISION現在のパイプライン実行のコミットの SHA1 ハッシュ。例: 46c360492d6372e5335300776806af412755871。
    BUDDY_EXECUTION_BRANCH現在のパイプライン実行の Git ブランチの名前。例: main。
    BUDDY_EXECUTION_TAG現在のパイプライン実行の Git タグの名前 (タグ付けされている場合)。例: v1.0.1。
    BUDDY_PIPELINE_ID実行されるパイプラインの ID。例: 1。
    BUDDY_EXECUTION_ID現在のパイプライン実行の ID。例: 1。
    BUDDY_PIPELINE_NAME実行されるパイプラインの名前。例: Deploy to Production。
    BUDDY_EXECUTION_URL現在のパイプライン実行の URL。例: https://app.buddy.works/my-workspace/my-project/pipelines/pipeline/1
    BUDDY_EXECUTION_REVISION_MESSAGE現在実行中のリビジョンのコミット メッセージ。例: we need to write unit tests!。
    BUDDY_EXECUTION_REVISION_COMMITTER_NAME現在実行中のリビジョンのコミッターの名前。例: Mike Benson。
    BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL現在実行中のリビジョンのコミッターのメール アドレス。例: [email protected]。

    Buddy CI がビルドごとに設定する環境変数の詳細な一覧については、Buddy CI の公式ドキュメントを参照してください。

    参考資料

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

    Test Optimization についてドキュメント more more