The Datadog Jenkins plugin can either report metrics through the Datadog Agent or directly to Datadog if an API key is provided. If you don’t have a Datadog Agent running on the Jenkins controller instance, Datadog recommends installing it first by following the Agent installation instructions.
If the Jenkins controller and the Datadog Agent have been deployed to a Kubernetes cluster, Datadog recommends using the Admission Controller, which automatically sets the DD_AGENT_HOST environment variable in the Jenkins controller pod to communicate with the local Datadog Agent.
Note: Unix domain sockets are not yet supported for sending CI Visibility traces.
Add logs_enabled: true to your Agent configuration file datadog.yaml, or set the DD_LOGS_ENABLED=true environment variable.
Create a file at /etc/datadog-agent/conf.d/jenkins.d/conf.yaml with the contents below. Make sure that service matches the CI instance name provided earlier.
Add logs_enabled: true to your Agent configuration file datadog.yaml, or set the DD_LOGS_ENABLED=true environment variable.
Create a file at %ProgramData%\Datadog\conf.d\jenkins.d\conf.yaml with the contents below. Make sure that service matches the CI instance name provided earlier.
Add logs_enabled: true to your Agent configuration file datadog.yaml, or set the DD_LOGS_ENABLED=true environment variable.
Create a file at ~/.datadog-agent/conf.d/jenkins.d/conf.yaml with the contents below. Make sure that service matches the CI instance name provided earlier.
Create or modify the configuration YAML by adding an entry for datadogGlobalConfiguration:
unclassified:datadogGlobalConfiguration:# Select the `Datadog Agent` mode (DSD).reportWith:"DSD"# Configure the `Agent` hosttargetHost:"<your-agent-host>"# Configure the `Traces Collection` porttargetTraceCollectionPort:8126# Enable CI Visibility flagenableCiVisibility:true# (Optional) Configure your CI Instance nameciInstanceName:"jenkins"
In your Jenkins instance web interface, go to Manage Jenkins > Configuration as Code.
Apply or reload the configuration.
Check the configuration using the View Configuration button.
Create or modify the configuration YAML by adding an entry for datadogGlobalConfiguration:
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 keytargetCredentialsApiKey:"<your-api-key>"# (Optional) Configure your CI Instance nameciInstanceName:"jenkins"
In your Jenkins instance web interface, go to Manage Jenkins > Configuration as Code.
Apply or reload the configuration.
Check the configuration using the View Configuration button.
Configure with Groovy
In your Jenkins instance web interface, go to Manage Jenkins > Script Console.
Run the configuration script:
importjenkins.model.*importorg.datadog.jenkins.plugins.datadog.DatadogGlobalConfigurationdefj=Jenkins.getInstance()defd=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()
In your Jenkins instance web interface, go to Manage Jenkins > Script Console.
Run the configuration script:
importjenkins.model.*importorg.datadog.jenkins.plugins.datadog.DatadogGlobalConfigurationdefj=Jenkins.getInstance()defd=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()
Use environment variables
Set the following environment variables on your Jenkins instance machine:
# Select the Datadog Agent modeDATADOG_JENKINS_PLUGIN_REPORT_WITH=DSD
# Configure the Agent hostDATADOG_JENKINS_PLUGIN_TARGET_HOST=your-agent-host
# Configure the Traces Collection port (default 8126)DATADOG_JENKINS_PLUGIN_TARGET_TRACE_COLLECTION_PORT=8126# Enable CI VisibilityDATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true# (Optional) Configure your CI Instance nameDATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins
Restart your Jenkins instance.
Set the following environment variables on your Jenkins instance machine:
# Select the Datadog Agent modeDATADOG_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 keyDATADOG_JENKINS_PLUGIN_TARGET_API_KEY=your-api-key
# Enable CI VisibilityDATADOG_JENKINS_PLUGIN_ENABLE_CI_VISIBILITY=true# (Optional) Configure your CI Instance nameDATADOG_JENKINS_PLUGIN_CI_VISIBILITY_CI_INSTANCE_NAME=jenkins
Restart your Jenkins instance.
Validate the configuration
To verify that CI Visibility is enabled, go to Jenkins Log and search for:
Set and export a new environment variable called DD_CI_HOSTNAME in every Jenkins worker with the worker hostname.
It must be the same hostname that the Datadog Agent is reporting in the infrastructure metrics for that worker.
You can use fixed values or other environment variables as valid values.
exportDD_CI_HOSTNAME=my-hostname
If you are using Kubernetes to manage your Jenkins instances, add the DD_CI_HOSTNAME environment variable to the pod that executes the Jenkins job. The value of this environment variable depends on what you are using in your Datadog Agent daemonset when reporting the infrastructure metrics.
This is only required for Jenkins workers. For the Jenkins controller, the infrastructure metric correlation does not require additional actions.
Note: Infrastructure metric correlation is supported since Jenkins Plugin v5.0.0+
Enable job log collection
This is an optional step that enables the collection of job logs.
Enable with the Jenkins configuration UI
In the web interface of your Jenkins instance, go to Manage Jenkins > Configure System.
Go to the Datadog Plugin section, scrolling down the configuration screen.
Double check that the Use the Datadog Agent to report to Datadog option is selected.
Configure the Log Collection port, as configured in the Datadog Agent.
Click on the Enable Log Collection checkbox to activate it.
Check the connectivity with the Datadog Agent.
Save your configuration.
In the web interface of your Jenkins instance, go to Manage Jenkins > Configure System.
Go to the Datadog Plugin section, scrolling down the configuration screen.
Double check that Use the Datadog Agent to report to Datadog is selected and that Log Intake URL points to a URL in your current Datadog site.
Click on the Enable Log Collection checkbox to activate it.
Modify the configuration YAML for the entry datadogGlobalConfiguration to include the following:
unclassified:datadogGlobalConfiguration:# Configure the `Log Collection` port, as configured in the Datadog Agent,targetLogCollectionPort:10518# Enable Log collectioncollectBuildLogs:true
In your Jenkins instance web interface, go to Manage Jenkins > Configuration as Code.
Apply or reload the configuration.
Check the configuration using the View Configuration button.
Modify the configuration YAML for the entry datadogGlobalConfiguration to include the following:
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 collectioncollectBuildLogs:true
In your Jenkins instance web interface, go to Manage Jenkins > Configuration as Code.
Apply or reload the configuration.
Check the configuration using the View Configuration button.
Enable with Groovy
In your Jenkins instance web interface, go to Manage Jenkins > Script Console.
Update your configuration script to include the following:
importjenkins.model.*importorg.datadog.jenkins.plugins.datadog.DatadogGlobalConfigurationdefj=Jenkins.getInstance()defd=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()
In your Jenkins instance web interface, go to Manage Jenkins > Script Console.
Update your configuration script to include the following:
importjenkins.model.*importorg.datadog.jenkins.plugins.datadog.DatadogGlobalConfigurationdefj=Jenkins.getInstance()defd=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()
Use environment variables
Add the following environment variables on your Jenkins instance machine:
# Configure the Log Collection port, as configured in the previous step.DATADOG_JENKINS_PLUGIN_TARGET_LOG_COLLECTION_PORT=10518# Enable log collectionDATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true
Restart your Jenkins instance.
Add the following environment variables on your Jenkins instance machine:
# 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 collectionDATADOG_JENKINS_PLUGIN_COLLECT_BUILD_LOGS=true
Restart your Jenkins instance.
Set the default branch name
To report pipeline results, attach the default branch name (for example, main) to pipeline spans in an attribute called git.default_branch. This is usually done automatically, but in some cases the plugin cannot extract this information because it might not be provided by Jenkins.
If this happens, set the default branch manually using the DD_GIT_DEFAULT_BRANCH environment variable in your build. For example:
Propagate Git information in pipelines without a Jenkinsfile from SCM
The Jenkins plugin uses environment variables to determine the Git information. However, these environment variables may not be available if you are not using a Jenkinsfile in your repository, and you’re configuring the pipeline directly in Jenkins using the checkout step.
In this case, you can propagate the Git information to the environment variables in your build. Use the .each {k,v -> env.setProperty(k, v)} function after executing the checkout or git steps. For example:
If you’re using a declarative pipeline to configure your pipeline, propagate Git information using a script block as follows:
The Jenkins plugin uses environment variables to determine the Git information. However, these environment variables are not always set
automatically due to dependencies on the Git plugin that is being used in the pipeline.
If the Git information is not detected automatically, you can set the following environment variables manually.
Note: These variables are optional, but if they are set, they take precedence over the Git information set by other Jenkins plugins.
DD_GIT_REPOSITORY (Optional)
The repository URL of your service. Example: https://github.com/my-org/my-repo.git
DD_GIT_BRANCH (Optional)
The branch name. Example: main
DD_GIT_TAG (Optional)
The tag of the commit (if any). Example: 0.1.0
DD_GIT_COMMIT_SHA (Optional)
The commit expressed in the hex 40 chars length form. Example: faaca5c59512cdfba9402c6e67d81b4f5701d43c
DD_GIT_COMMIT_MESSAGE (Optional)
The commit message. Example: Initial commit message
DD_GIT_COMMIT_AUTHOR_NAME (Optional)
The name of the author of the commit. Example: John Smith
DD_GIT_COMMIT_AUTHOR_EMAIL (Optional)
The email of the author of the commit. Example: john@example.com
DD_GIT_COMMIT_AUTHOR_DATE (Optional)
The date when the author submitted the commit expressed in ISO 8601 format. Example: 2021-08-16T15:41:45.000Z
DD_GIT_COMMIT_COMMITTER_NAME (Optional)
The name of the committer of the commit. Example: Jane Smith
DD_GIT_COMMIT_COMMITTER_EMAIL (Optional)
The email of the committer of the commit. Example: jane@example.com
DD_GIT_COMMIT_COMMITTER_DATE (Optional)
The date when the committer submitted the commit expressed in ISO 8601 format. Example: 2021-08-16T15:41:45.000Z
If you set only repository, branch and commit, the plugin will try to extract the rest of the Git information from the .git folder.
An example of usage:
pipeline{agentanystages{stage('Checkout'){steps{script{defgitVars=giturl:'https://github.com/my-org/my-repo.git',branch:'some/feature-branch'// Setting Git information manually via environment variables.
env.DD_GIT_REPOSITORY_URL=gitVars.GIT_URLenv.DD_GIT_BRANCH=gitVars.GIT_BRANCHenv.DD_GIT_COMMIT_SHA=gitVars.GIT_COMMIT}}}stage('Test'){steps{// Execute the rest of the pipeline.
}}}}
Customization
Set custom tags for your pipelines
The Datadog plugin adds a datadog step that allows adding custom tags to your pipeline-based jobs.
In declarative pipelines, add the step to a top-level option block:
You can configure the Jenkins Plugin to send custom tags in all pipeline traces:
In the web interface of your Jenkins instance, go to Manage Jenkins > Configure System.
Go to the Datadog Plugin section, scrolling down the configuration screen.
Click on the Advanced button.
Configure the Global Tags.
Configure the Global Job Tags.
Save your configuration.
Global tags
A comma-separated list of tags to apply to all metrics, traces, events, and service checks. Tags can include environment variables that are defined in the Jenkins controller instance. Environment variable: DATADOG_JENKINS_PLUGIN_GLOBAL_TAGS Example: key1:value1,key2:${SOME_ENVVAR},${OTHER_ENVVAR}:value3
Global job tags
A comma-separated list of regexes to match a job and a list of tags to apply to that job. Tags can include environment variables that are defined in the Jenkins controller instance. Tags can reference match groups in the regex using the $ symbol. Environment variable: DATADOG_JENKINS_PLUGIN_GLOBAL_JOB_TAGS Example: (.*?)_job_(.*?)_release, owner:$1, release_env:$2, optional:Tag3
Include or exclude pipelines
You can configure the Jenkins Plugin to include or exclude some pipelines:
In the web interface of your Jenkins instance, go to Manage Jenkins > Configure System.
Go to the Datadog Plugin section by scrolling down the configuration screen.
Click on the Advanced button.
Configure the Excluded Jobs.
Configure the Included Jobs.
Save your configuration.
Excluded jobs
A comma-separated list of Jenkins jobs that should not be monitored. The exclusion applies to all metrics, traces, events, and service checks. Excluded jobs can use regular expressions to reference multiple jobs. Environment variable: DATADOG_JENKINS_PLUGIN_EXCLUDED Example: susans-job,johns-.*,prod_folder/prod_release
Included jobs
A comma-separated list of Jenkins job names that should be monitored. If the included jobs list is empty, all jobs that are not excluded explicitly are monitored. The inclusion applies to all metrics, traces, events, and service checks. Included jobs can use regular expressions to reference multiple jobs. Environment variable: DATADOG_JENKINS_PLUGIN_INCLUDED Example: susans-job,johns-.*,prod_folder/prod_release
Visualize pipeline data in Datadog
Once the integration is successfully configured, both the Pipelines and Pipeline Executions pages populate with data after pipelines finish.
Note: The Pipelines page shows data for only the default branch of each repository.
Troubleshooting
Enable DEBUG log level for the Datadog Plugin
If you have any issues with the Datadog Plugin, you can set the logs for the plugin in DEBUG level. Using this level you are able to see stacktrace details if an exception is thrown.
In your Jenkins instance web interface, go to Manage Jenkins > System log.
Click on Add new log recorder button.
Type the log recorder name. E.g: Datadog Plugin Logs.
Add the following loggers to the list:
Logger: org.datadog.jenkins.plugins.datadog.clients -> Log Level ALL
Logger: org.datadog.jenkins.plugins.datadog.traces -> Log Level ALL
Logger: org.datadog.jenkins.plugins.datadog.logs -> Log Level ALL
Logger: org.datadog.jenkins.plugins.datadog.model -> Log Level ALL
Logger: org.datadog.jenkins.plugins.datadog.listeners -> Log Level ALL
Save the configuration.
You may also want to split the loggers into different log recorders.
Once the log recorders are successfully configured, you can check the logs in the DEBUG mode by accessing the desired log recorder through Manage Jenkins > System log.
If you trigger a Jenkins pipeline, you can search for the message Send pipeline traces in the Datadog Plugin Logs. This message indicates that the plugin is sending CI Visibility data to the Datadog Agent.
The Datadog Plugin cannot write payloads to the server
If the following error message appears in the Jenkins Log, make sure that the plugin configuration is correct.
Error writing to server
If you are using localhost as the hostname, try to change it to the server hostname instead.
If your Jenkins instance is behind an HTTP proxy, go to Manage Jenkins > Manage Plugins > Advanced tab and make sure the proxy configuration is correct.
HTTP 504
If the HTTP 504 error message appears, make sure that the Jenkins proxy configuration is correct.
Failed to send HTTP request: PUT http://localhost:8126/v0.3/traces - Status: HTTP 504
If your Jenkins instance is behind an HTTP proxy, go to Manage Jenkins > Manage Plugins > Advanced tab and make sure the proxy configuration is correct.
Check that localhost has been configured in the No Proxy Hosts section.
The Datadog Plugin section does not appear in the Jenkins configuration
If the Datadog Plugin section does not appear in Jenkins configuration section, make sure that the plugin is enabled. To do so:
In your Jenkins instance web interface, go to Manage Jenkins > Manage Plugins.
Search for Datadog Plugin in the Installed tab.
Check that the Enabled checkbox is marked.
If you enable the plugin here, restart your Jenkins instance using the /safeRestart URL path.
The CI Visibility option does not appear in the Datadog Plugin section.
If the CI Visibility option does not appear in the Datadog Plugin section, make sure that the correct version is installed and restart the Jenkins instance. To do so:
In your Jenkins instance web interface, go to Manage Jenkins > Manage Plugins.
Search for Datadog Plugin in the Installed tab.
Check that the installed version is correct.
Restart your Jenkins instance using the /safeRestart URL path.
The Plugin’s Tracer fails to initialize due to APM Java Tracer is being used to instrument Jenkins.
If this error message appears in the Jenkins Log, make sure that you are using the Jenkins plugin v3.1.0+
Failed to reinitialize Datadog-Plugin Tracer, Cannot enable traces collection via plugin if the Datadog Java Tracer is being used as javaagent in the Jenkins startup command. This error will not affect your pipelines executions.
Further reading
Additional helpful documentation, links, and articles: