A Jenkins plugin used to forward metrics, events, and service checks to an account at Datadog, automatically.
There is a Jenkins-CI Wiki page for this plugin, but it refers to our DataDog/jenkins-datadog-plugin for documentation.
Currently, the plugin is tracking the following data.
List of events:
- Started build
- Finished build
List of metrics:
- Build duration, in seconds (jenkins.job.duration)
- Jobs completed (jenkins.job.completed) - Sent via dogstatsd. Requires the Datadog Agent to be installed on the Jenkins host.
List of service checks:
- Build status (jenkins.job.status)
All events, metrics, and service checks include the following tags, if they are available:
- job
- result
- branch
Optional tags, included in events, metrics, and service checks. (Toggle from Manage Jenkins -> Configure System)
- node (disabled by default)
From the global configuration page, at Manage Jenkins -> Configure System.
- Blacklisted Jobs
- A comma-separated list of job names that should not monitored. (eg: susans-job,johns-job,prod_folder/prod_release).
From a job specific configuration page
- Custom tags
- Added from a file in the job workspace (not compatible with Pipeline jobs), or
- Added as text directly from the configuration page
This plugin requires Jenkins 1.580.1 or newer.
This plugin can be installed from the Update Center (found at Manage Jenkins -> Manage Plugins) in your Jenkins installation. Select the Available tab, search for Datadog and look for Datadog Plugin. Once you find it, check the checkbox next to it, and install via your preference by using one of the two install buttons at the bottom of the screen. Check to see that the plugin has been successfully installed by searching for Datadog Plugin on the Installed tab. If the plugin has been successfully installed, then continue on to the configuration step, described below.
Note: If you do not see the version of Datadog Plugin that you are expecting, make sure you have run Check Now from the Manage Jenkins -> Manage Plugins screen.
To configure your newly installed Datadog Plugin, simply navigate to the Manage Jenkins -> Configure System page on your Jenkins installation. Once there, scroll down to find the Datadog Plugin section. Find your API Key from the API Keys page on your Datadog account, and copy/paste it into the API Key textbox on the Jenkins configuration screen. You can test that your API Key works by pressing the Test Key button, on the Jenkins configuration screen, directly below the API Key textbox. Once your configuration changes are finished, simply save them, and you're good to go!
Alternatively, you have the option of configuring your Datadog plugin using a Groovy script like this one:
import jenkins.model.*
import org.datadog.jenkins.plugins.datadog.DatadogBuildListener
def j = Jenkins.getInstance()
def d = j.getDescriptor("org.datadog.jenkins.plugins.datadog.DatadogBuildListener")
d.setHostname('https://your-jenkins.com:8080')
d.setTagNode(true)
d.setApiKey('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
d.setBlacklist('job1,job2')
d.save()Configuring the plugin this way might be useful if you're running your Jenkins Master in a Docker container using the Official Jenkins Docker Image or any derivative that supports plugins.txt and Groovy init scripts.
Logging is done by utilizing the java.util.Logger, which follows the best logging practices for Jenkins. In order to obtain logs, follow the directions listed here. When adding a Logger, all Datadog plugin functions start with org.datadog.jenkins.plugins.datadog. and the function name you're after should autopopulate. As of this writing, the only function available was org.datadog.jenkins.plugins.datadog.DatadogBuildListener.
Our DataDog/jenkins-datadog-plugin repository handles the most up-to-date changes we've made to the Datadog Plugin, as well as issue tickets revolving around that work. Releases are merged to the Jenkins-CI git repo for our plugin, and represents the source used for plugin releases found in the Update Center in your Jenkins installation.
Every commit to our DataDog/jenkins-datadog-plugin repository triggers a Jenkins build on our internal Jenkins installation.
A list of our releases is here.
To release a new plugin version, change the project version in the pom.xml from x.x.x-SNAPSHOT to the updated version number you'd like to see. Add an entry for the new release number to CHANGELOG.md, and ensure that all the changes are listed accurately. Then run the jenkins-datadog-plugin-release job in our Jenkins installation. If the job completes successfully, then the newly updated plugin should be available from the Jenkins Update Center within ~4 hours (plus mirror propogation time).
We use Github's built in issue tracking system for all issues tickets relating to this plugin, found here. However, given how Jenkins Plugins are hosted, there may be issues that are posted to JIRA as well. You can check here for those issue postings.
Here are unresolved issues on JIRA mentioning Datadog.
See the CHANGELOG.md
First of all and most importantly, thank you for sharing.
If you want to submit code, please fork this repository and submit pull requests against the master branch.
For more information, checkout the contributing guidelines for our agent. We'll attempt to follow these here, as well, where it makes sense.
In order to keep track of some testing procedures for ensuring proper functionality of the Datadog Plugin on Jenkins, there is a testing document.