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

1. Agent のコンフィギュレーションファイル datadog.yaml に logs_enabled: true を追加するか、DD_LOGS_ENABLED=true 環境変数を設定します。　

2. /etc/datadog-agent/conf.d/jenkins.d/conf.yaml に以下の内容のファイルを作成します。service が以前に提供された CI インスタンス名と一致することを確認してください。

   logs:
   - type: tcp
     port: 10518
     service: my-jenkins-instance
     source: jenkins
   

3. Agent を再起動して変更を有効にします。

1. Agent のコンフィギュレーションファイル datadog.yaml に logs_enabled: true を追加するか、DD_LOGS_ENABLED=true 環境変数を設定します。　

2. %ProgramData%\Datadog\conf.d\jenkins.d\conf.yaml に以下の内容のファイルを作成します。service が以前に提供された CI インスタンス名と一致することを確認してください。

   logs:
   - type: tcp
     port: 10518
     service: my-jenkins-instance
     source: jenkins
   

3. Agent を再起動して変更を有効にします。

1. Agent のコンフィギュレーションファイル datadog.yaml に logs_enabled: true を追加するか、DD_LOGS_ENABLED=true 環境変数を設定します。　

2. ~/.datadog-agent/conf.d/jenkins.d/conf.yaml に以下の内容のファイルを作成します。service が以前に提供された CI インスタンス名と一致することを確認してください。

   logs:
   - type: tcp
     port: 10518
     service: my-jenkins-instance
     source: jenkins
   

3. Agent を再起動して変更を有効にします。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configure System にアクセスします。
2. コンフィギュレーション画面を下にスクロールして、Datadog Plugin セクションに移動します。
3. Use the Datadog Agent to report to Datadog (Datadog Agent を使用して Datadog に報告する) のモードを選択します。
4. Agent ホストを構成します。
5. デフォルトのポート 8126 を使用していない場合は、Traces Collection Port を構成してください。
6. Enable CI Visibility チェックボックスをオンにします。
7. (オプション) CI インスタンス名を構成します。
8. Datadog Agent との接続を確認します。
9. 構成を保存します。

このオプションを使用すると、Jenkins プラグインは Datadog Agent を使用せずに Datadog に直接レポートするようになります。これには、API キーが必要です。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configure System にアクセスします。
2. コンフィギュレーション画面を下にスクロールして、Datadog Plugin セクションに移動します。
3. Use Datadog API URL and Key to report to Datadog (Datadog API URL とキーを使用して Datadog に報告する) のモードを選択します。
4. datadoghq.com 以外の Datadog サイトでは、Datadog API URL 、Log Intake URL 、Webhook Intake URL を Datadog サイトを指すように変更します。
5. 有効な Datadog API Key を入力します。
6. Enable CI Visibility チェックボックスをオンにします。
7. (オプション) CI インスタンス名を構成します。
8. 構成を保存します。

Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:

1. datadogGlobalConfiguration のエントリを追加して、コンフィギュレーション YAML を作成または変更します。

   unclassified:
       datadogGlobalConfiguration:
           # Select the `Datadog Agent` mode (DSD).
           reportWith: "DSD"
           # Configure the `Agent` host
           targetHost: "<your-agent-host>"
           # Configure the `Traces Collection` port
           targetTraceCollectionPort: 8126
           # Enable CI Visibility flag
           enableCiVisibility: true
           # (Optional) Configure your CI Instance name
           ciInstanceName: "jenkins"
   

2. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configuration as Code にアクセスします。

3. コンフィギュレーションを適用または再ロードします。

4. View Configuration ボタンを使用してコンフィギュレーションを確認します。

Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:

1. datadogGlobalConfiguration のエントリを追加して、コンフィギュレーション YAML を作成または変更します。

   unclassified:
       datadogGlobalConfiguration:
           # Select the `Agentless` mode (HTTP).
           reportWith: "HTTP"
           # Update the endpoints if reporting to Datadog sites other that `datadoghq.com`
           targetApiURL: "https://api.datadoghq.com/api/"
           targetLogIntakeURL: "https://http-intake.logs.datadoghq.com/v1/input/"
           targetWebhookIntakeURL: "https://webhook-intake.datadoghq.com/api/v2/webhook/"
           # Configure your API key
           targetCredentialsApiKey: "<your-api-key>"
           # (Optional) Configure your CI Instance name
           ciInstanceName: "jenkins"
   

2. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configuration as Code にアクセスします。

3. コンフィギュレーションを適用または再ロードします。

4. View Configuration ボタンを使用してコンフィギュレーションを確認します。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Script Console にアクセスします。

2. コンフィギュレーションスクリプトを実行します。

   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('<your-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()
   

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Script Console にアクセスします。

2. コンフィギュレーションスクリプトを実行します。

   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('HTTP')
   
   // Update the endpoints if reporting to Datadog sites other that `datadoghq.com` (default)
   d.setTargetApiURL("https://api.datadoghq.com/api/")
   d.setTargetLogIntakeURL("https://http-intake.logs.datadoghq.com/v1/input/")
   d.setTargetWebhookIntakeURL("https://webhook-intake.datadoghq.com/api/v2/webhook/")
   
   // Configure your API key
   d.setTargetApiKey("your-api-key")
   
   // Enable CI Visibility
   d.setEnableCiVisibility(true)
   
   // (Optional) Configure your CI Instance name
   d.setCiInstanceName("jenkins")
   
   // Save config
   d.save()
   

1. Jenkins インスタンスマシンで次の環境変数を設定します。

   # Select the Datadog Agent mode
   DATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD
   
   # Configure the Agent host
   DATADOG_JENKINS_PLUGIN_TARGET_HOST=your-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
   

2. Jenkins インスタンスを再起動します。

1. Jenkins インスタンスマシンで次の環境変数を設定します。

   # Select the Datadog Agent mode
   DATADOG_JENKINS_PLUGIN_REPORT_WITH=HTTP
   
   # Update the endpoints if reporting to Datadog sites other that `datadoghq.com` (default)
   DATADOG_JENKINS_PLUGIN_TARGET_API_URL="https://api.datadoghq.com/api/"
   DATADOG_JENKINS_PLUGIN_TARGET_LOG_INTAKE_URL="https://http-intake.logs.datadoghq.com/v1/input/"
   DATADOG_JENKINS_TARGET_WEBHOOK_INTAKE_URL="https://webhook-intake.datadoghq.com/api/v2/webhook/"
   
   # Configure your API key
   DATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key
   
   # 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
   

2. Jenkins インスタンスを再起動します。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configure System に移動します。
2. コンフィギュレーション画面を下にスクロールして、Datadog Plugin セクションに移動します。
3. Use the Datadog Agent to report to Datadog オプションが選択されていることを再度確認します。
4. Datadog Agent で構成した Log Collection ポートを構成します。
5. Enable Log Collection チェックボックスをクリックしてアクティブにします。
6. Datadog Agent との接続を確認します。
7. 構成を保存します。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configure System に移動します。
2. コンフィギュレーション画面を下にスクロールして、Datadog Plugin セクションに移動します。
3. Use the Datadog Agent to report to Datadog が選択されていることと、Log Intake URL が現在の Datadog サイトの URL を指していることを再度確認します。
4. Enable Log Collection チェックボックスをクリックしてアクティブにします。
5. 構成を保存します。

Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:

1. エントリ datadogGlobalConfiguration の構成 YAML に、以下を含めるように修正します。

   unclassified:
   datadogGlobalConfiguration:
       # Configure the `Log Collection` port, as configured in the Datadog Agent,
       targetLogCollectionPort: 10518
       # Enable Log collection
       collectBuildLogs: true
   

2. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configuration as Code にアクセスします。
3. コンフィギュレーションを適用または再ロードします。
4. View Configuration ボタンを使用してコンフィギュレーションを確認します。

Jenkins インスタンスが Jenkins configuration-as-code プラグインを使用する場合:

1. エントリ datadogGlobalConfiguration の構成 YAML に、以下を含めるように修正します。

   unclassified:
   datadogGlobalConfiguration:
       # Update the endpoints if reporting to Datadog sites other that `datadoghq.com`
       targetLogIntakeURL: "https://http-intake.logs.datadoghq.com/v1/input/"
       # Enable Log collection
       collectBuildLogs: true
   

2. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Configuration as Code にアクセスします。
3. コンフィギュレーションを適用または再ロードします。
4. View Configuration ボタンを使用してコンフィギュレーションを確認します。

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Script Console にアクセスします。
2. 構成スクリプトを、以下を含めるように更新します。

   import jenkins.model.*
   import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration
   
   def j = Jenkins.getInstance()
   def d = j.getDescriptor("org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration")
   
   // Configure the Log Collection port, as configured in the Datadog Agent.
   d.setTargetLogCollectionPort(10518)
   
   // Enable log collection
   d.setCollectBuildLogs(true)
   
   // Save config
   d.save()
   

1. Jenkins インスタンスの Web インターフェースで、Manage Jenkins > Script Console にアクセスします。
2. 構成スクリプトを、以下を含めるように更新します。

   import jenkins.model.*
   import org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration
   
   def j = Jenkins.getInstance()
   def d = j.getDescriptor("org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration")
   
   // Update the endpoints if reporting to Datadog sites other that `datadoghq.com`
   d.setTargetLogIntakeURL("https://http-intake.logs.datadoghq.com/v1/input/")
   
   // Enable log collection
   d.setCollectBuildLogs(true)
   
   // Save config
   d.save()
   

1. Jenkins インスタンスマシンで次の環境変数を追加します。

   # 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
   

2. Jenkins インスタンスを再起動します。

1. Jenkins インスタンスマシンで次の環境変数を追加します。

   # Update the endpoints if reporting to Datadog sites other that `datadoghq.com`
   DATADOG_JENKINS_PLUGIN_TARGET_LOG_INTAKE_URL="https://http-intake.logs.datadoghq.com/v1/input/"
   
   # Enable log collection
   DATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true
   

2. Jenkins インスタンスを再起動します。

宣言型パイプラインを使ってパイプラインの構成を行う場合は、以下のように 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)}
  }
  ...
}