- 重要な情報
- はじめに
- 用語集
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
対応する Jenkins のバージョン:
Jenkins コントローラーインスタンスに Datadog Agent をインストールします。
Jenkins コントローラーと Datadog Agent が Kubernetes クラスターにデプロイされている場合、Datadog では、Jenkins コントローラーポッドに環境変数 DD_AGENT_HOST を自動的に設定して、ローカル Datadog Agent と通信する Admission Controller を使用することを推奨しています。
Datadog Jenkins プラグイン v3.3.0 以降をインストールおよび有効化します:
Datadog Plugin を探します。 Datadog Plugin を検索し、プラグインがインストールされたことを確認します。Datadog Plugin セクションに移動します。Datadog Agent モードを選択します。Datadog API の URL と API キーを使用した CI Visibility はサポートされていません。Agent ホストを構成します。Traces Collection ポート (デフォルトは 8126) を構成します。Enable CI Visibility チェックボックスをクリックしてアクティブにします。Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:
datadogGlobalConfiguration のエントリを追加して、コンフィギュレーション YAML を作成または変更します。unclassified:
datadogGlobalConfiguration:
# Select the `Datadog Agent` mode.
reportWith: "DSD"
# Configure the `Agent` host
targetHost: "agent-host"
# Configure the `Traces Collection` port (default `8126`).
targetTraceCollectionPort: 8126
# Enable CI Visibility flag
enableCiVisibility: true
# (Optional) Configure your CI Instance name
ciInstanceName: "jenkins"
View Configuration ボタンを使用してコンフィギュレーションを確認します。import jenkins.model.*
import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration
def j = Jenkins.getInstance()
def d = j.getDescriptor("org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration")
// Select the Datadog Agent mode
d.setReportWith('DSD')
// Configure the Agent host.
d.setTargetHost('<agent host>')
// Configure the Traces Collection port (default 8126)
d.setTargetTraceCollectionPort(8126)
// Enable CI Visibility
d.setEnableCiVisibility(true)
// (Optional) Configure your CI Instance name
d.setCiInstanceName("jenkins")
// Save config
d.save()
# Select the Datadog Agent mode
DATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD
# Configure the Agent host
DATADOG_JENKINS_PLUGIN_TARGET_HOST=agent-host
# Configure the Traces Collection port (default 8126)
DATADOG_JENKINS_PLUGIN_TARGET_TRACE_COLLECTION_PORT=8126
# Enable CI Visibility
DATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true
# (Optional) Configure your CI Instance name
DATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins
CI Visibility が有効になっていることを確認するには、Jenkins Log に移動して次を検索します。
Re/Initialize Datadog-Plugin Agent Http Client
TRACE -> http://<HOST>:<TRACE_PORT>/v0.3/tracesJenkins のワーカーを使用している場合、パイプラインを実行しているインフラストラクチャーでパイプラインを関連付けることができます。この機能を動作させるには
DD_CI_HOSTNAME という新しい環境変数をワーカーのホスト名で設定し、エクスポートします。# 固定値を使用する
export DD_CI_HOSTNAME=my-hostname
# 他の環境変数を使用する
export DD_CI_HOSTNAME=$HOSTNAME
Jenkins インスタンスの管理に Kubernetes を使用している場合は、DD_CI_HOSTNAME 環境変数を Jenkins ジョブを実行するポッドに追加してください。この環境変数の値は、インフラストラクチャーメトリクスをレポートする際に、Datadog Agent のデーモンセットで何を使用しているかに依存します。
これは、Jenkins ワーカーにのみ必要です。Jenkins コントローラの場合、インフラストラクチャーメトリクスの相関は追加アクションを必要としません。
注: インフラストラクチャーメトリクスの相関は、Jenkins Plugin v5.0.0+ 以降でサポートされています。
これは、ジョブログの収集を可能にするオプションの手順です。これには、Datadog Agent でジョブ収集ポートを有効にする手順と、Datadog プラグインでジョブ収集を有効にする手順の 2 つの手順が含まれます。
まず、TCP ポートを開いてログを収集することにより、Datadog Agent でジョブログ収集を有効にします。
Agent のコンフィギュレーションファイル datadog.yaml に logs_enabled: true を追加するか、DD_LOGS_ENABLED=true 環境変数を設定します。
Linux の /etc/datadog-agent/conf.d/jenkins.d/conf.yaml に以下の内容のファイルを作成します。service が以前に提供された CI インスタンス名と一致することを確認してください。その他のオペレーティングシステムについては、Agent コンフィギュレーションディレクトリガイドを参照してください。
logs:
- type: tcp
port: 10518
service: my-jenkins-instance
source: jenkinsこの設定で、Agent はログをポート 10518 でリッスンします。
次に、Datadog プラグインでジョブログ収集を有効にします。
Datadog Plugin セクションに移動します。Datadog Agent モードを選択します。Agent ホストを構成します。Log Collection ポートを構成します。Enable Log Collection チェックボックスをクリックしてアクティブにします。Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:
datadogGlobalConfiguration のコンフィギュレーション YAML を作成または変更します。unclassified:
datadogGlobalConfiguration:
# Select the `Datadog Agent` mode.
reportWith: "DSD"
# Configure the `Agent` host
targetHost: "agent-host"
# Configure the `Log Collection` port, as configured in the previous step.
targetLogCollectionPort: 10518
# Enable Log collection
collectBuildLogs: true
View Configuration ボタンを使用してコンフィギュレーションを確認します。import jenkins.model.*
import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration
def j = Jenkins.getInstance()
def d = j.getDescriptor("org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration")
// Select the Datadog Agent mode
d.setReportWith('DSD')
// Configure the Agent host, if not previously configured.
d.setTargetHost('<agent host>')
// Configure the Log Collection port, as configured in the previous step.
d.setTargetLogCollectionPort(10518)
// Enable log collection
d.setCollectBuildLogs(true)
// Save config
d.save()
# Select the Datadog Agent mode
DATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD
# Configure the Agent host
DATADOG_JENKINS_PLUGIN_TARGET_HOST=agent-host
# Configure the Log Collection port, as configured in the previous step.
DATADOG_JENKINS_PLUGIN_TARGET_LOG_COLLECTION_PORT=10518
# Enable log collection
DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true
パイプラインの結果を報告するには、デフォルトのブランチ名 (例: main) をパイプラインのスパンに git.default_branch という属性で付加します。これは通常、自動的に行われますが、Jenkins からこの情報が提供されず、プラグインがこの情報を抽出できない場合もあります。
この場合、ビルドで DD_GIT_DEFAULT_BRANCH 環境変数を使用してデフォルトのブランチを手動で設定します。例:
pipeline {
agent any
environment {
DD_GIT_DEFAULT_BRANCH = 'main'
...
}
stages {
...
}
}Jenkins プラグインは、Git の情報を環境変数で判断しています。しかし、リポジトリで Jenkinsfile を使用しておらず、Jenkins で checkout ステップを使って直接パイプラインを構成している場合、これらの環境変数が利用できないことがあります。
この場合、Git の情報をビルドの環境変数に伝搬させることができます。checkout や git のステップを実行した後に、 .each {k,v -> env.setProperty(k, v)} という関数を使用します。例:
宣言型パイプラインを使ってパイプラインの構成を行う場合は、以下のように script ブロックを使って Git の情報を伝搬させます。
checkout ステップを使用する:
pipeline {
stages {
stage('Checkout') {
script {
checkout(...).each {k,v -> env.setProperty(k,v)}
}
}
...
}
}git ステップを使用する:
pipeline {
stages {
stage('Checkout') {
script {
git(...).each {k,v -> env.setProperty(k,v)}
}
}
...
}
}スクリプトパイプラインを使ってパイプラインの構成を行う場合は、git の情報を直接環境変数に伝搬させることができます。
checkout ステップを使用する:
node {
stage('Checkout') {
checkout(...).each {k,v -> env.setProperty(k,v)}
}
...
}git ステップを使用する:
node {
stage('Checkout') {
git(...).each {k,v -> env.setProperty(k,v)}
}
...
}Jenkins プラグインは、環境変数を使用して Git 情報を決定します。しかし、パイプラインで使用している Git プラグインに依存するため、これらの環境変数が常に自動的に設定されるわけではありません。
Git 情報が自動的に検出されない場合は、以下の環境変数を手動で設定することができます。
注: これらの変数はオプションですが、設定された場合、他の Jenkins プラグインで設定された Git 情報よりも優先されます。
DD_GIT_REPOSITORY (オプション)https://github.com/my-org/my-repo.gitDD_GIT_BRANCH (オプション)mainDD_GIT_TAG (オプション)0.1.0DD_GIT_COMMIT_SHA (オプション)faaca5c59512cdfba9402c6e67d81b4f5701d43cDD_GIT_COMMIT_MESSAGE (オプション)Initial commit messageDD_GIT_COMMIT_AUTHOR_NAME (オプション)John SmithDD_GIT_COMMIT_AUTHOR_EMAIL (オプション)john@example.comDD_GIT_COMMIT_AUTHOR_DATE (オプション)2021-08-16T15:41:45.000ZDD_GIT_COMMIT_COMMITTER_NAME (オプション)Jane SmithDD_GIT_COMMIT_COMMITTER_EMAIL (オプション)jane@example.comDD_GIT_COMMIT_COMMITTER_DATE (オプション)2021-08-16T15:41:45.000Zリポジトリ、ブランチ、コミットのみを設定した場合、プラグインは .git フォルダから残りの Git 情報を取り出そうとします。
使用方法の一例をご紹介します。
pipeline {
agent any
stages {
stage('Checkout') {
steps {
script {
def gitVars = git url:'https://github.com/my-org/my-repo.git', branch:'some/feature-branch'
// Git 情報を環境変数で手動設定する。
env.DD_GIT_REPOSITORY_URL=gitVars.GIT_URL
env.DD_GIT_BRANCH=gitVars.GIT_BRANCH
env.DD_GIT_COMMIT_SHA=gitVars.GIT_COMMIT
}
}
}
stage('Test') {
steps {
// 残りのパイプラインを実行します。
}
}
}
}Datadog プラグインは、パイプラインベースのジョブにカスタムタグを付加するために datadog ステップを追加します。
Declarative Pipeline で、このステップをトップレベルのオプションブロックに追加します:
def DD_TYPE = "release"
pipeline {
agent any
options {
datadog(tags: ["team:backend", "type:${DD_TYPE}", "${DD_TYPE}:canary"])
}
stages {
stage('Example') {
steps {
echo "Hello world."
}
}
}
}Scripted Pipeline で、関連するセクションを datadog ステップでラップします:
datadog(tags: ["team:backend", "release:canary"]){
node {
stage('Example') {
echo "Hello world."
}
}
}すべてのパイプライントレースにカスタムタグを送信するよう、Jenkins プラグインを構成することができます:
Datadog Plugin セクションに移動します。Advanced ボタンをクリックします。Global Tags を構成します。Global Job Tags を構成します。DATADOG_JENKINS_PLUGIN_GLOBAL_TAGSkey1:value1,key2:${SOME_ENVVAR},${OTHER_ENVVAR}:value3$ 記号を使用して正規表現内の一致グループを参照できます。DATADOG_JENKINS_PLUGIN_GLOBAL_JOB_TAGS(.*?)_job_(.*?)_release, owner:$1, release_env:$2, optional:Tag3一部のパイプラインを含めるか除外するように Jenkins プラグインを構成できます。
Datadog Plugin セクションに移動します。Advanced ボタンをクリックします。Excluded Jobs を構成します。Included Jobs を構成します。DATADOG_JENKINS_PLUGIN_EXCLUDEDsusans-job,johns-.*,prod_folder/prod_releaseDATADOG_JENKINS_PLUGIN_INCLUDEDsusans-job,johns-.*,prod_folder/prod_releaseインテグレーションが正常に構成されたら、パイプラインが終了した後、Pipelines ページと Pipeline Executions ページの両方にデータが入力されます。
注: Pipelines ページには、各リポジトリのデフォルトブランチのデータのみが表示されます。
Datadog プラグインに問題がある場合は、プラグインのログを DEBUG レベルで設定できます。このレベルを使用すると、例外がスローされた場合にスタックトレースの詳細を確認できます。
Add new log recorder ボタンをクリックします。org.datadog.jenkins.plugins.datadog.clients -> Log Level ALLorg.datadog.jenkins.plugins.datadog.traces -> Log Level ALLorg.datadog.jenkins.plugins.datadog.logs -> Log Level ALLorg.datadog.jenkins.plugins.datadog.model -> Log Level ALLorg.datadog.jenkins.plugins.datadog.listeners -> Log Level ALLロガーを異なるログレコーダーに分割することもできます。
ログレコーダーが正常に構成されたら、Manage Jenkins > System log から目的のログレコーダーにアクセスして、DEBUG モードでログを確認できます。
Jenkins パイプラインをトリガーすると、Datadog Plugin Logs でメッセージ Send pipeline traces を検索できます。このメッセージは、プラグインが CI Visibility データを Datadog Agent に送信していることを示しています。
Send pipeline traces.
...
Send pipeline traces.
...Jenkins Log に以下のエラーメッセージが表示された場合、プラグインの構成が正しいかどうか確認してください。
Error writing to serverlocalhost を使用している場合は、代わりにサーバーのホスト名に変更してみてください。HTTP 504 のエラーメッセージが表示される場合は、Jenkins のプロキシ構成が正しいかどうかを確認してください。
Failed to send HTTP request: PUT http://localhost:8126/v0.3/traces - Status: HTTP 504No Proxy Hosts に localhost が構成されていることを確認します。Datadog プラグインセクションが Jenkins コンフィギュレーションセクションに表示されない場合は、プラグインが有効になっていることを確認してください。手順:
Datadog Plugin を検索します。Enabled チェックボックスがオンになっていることを確認します。/safeRestart URL パスを使用して Jenkins インスタンスを再起動します。CI Visibility オプションが Datadog プラグインセクションに表示されない場合は、正しいバージョンがインストールされていることを確認して、Jenkins インスタンスを再起動してください。手順:
Datadog Plugin を検索します。/safeRestart URL パスを使用して Jenkins インスタンスを再起動します。このエラーメッセージが Jenkins Log に表示される場合は、Jenkins プラグイン v3.1.0 以降を使用していることを確認してください
Datadog-Plugin Tracer の再初期化に失敗した。Jenkins 起動コマンドで Datadog Java Tracer が javaagent として使用されている場合、プラグインを介したトレース収集を有効にできない。このエラーは、パイプラインの実行には影響しません。
