{jenkins-plugin-info:influxdb}

Sends Jenkins build metrics into InfluxDB

Description

The InfluxDB plugin allows to send various metrics to InfluxDB. It gets its data from other data available in Jenkins. For example, unit test results are gathered from the JUnit Plugin and Robot Framework results from the Robot Framework Plugin etc.

From version 1.13 onwards different plugins are listed as optional dependencies. In order to get rid of mandatory dependency errors, InfluxDB plugin must be re-installed.

From version 2.0 onwards "selectedTarget" is a mandatory parameter for pipelines and "target" parameter is no longer supported.

Configuration As Code: the configuration needs to be changed from `influxDbPublisher` to `influxDbGlobalConfig`.

Might cause issues when creating new targets in pipelines. The InfluxDbPublisher instance is now under jenkinsci.plugins.influxdb.InfluxDbStep.DescriptorImpl.


Supported Metrics

MeasurementDataRelated plugin
All
  • Build number
  • Project name
  • Project path

jenkins_data
  • Build health
  • Build status message
  • Build time
  • Build Agent name
  • Job duration
  • Build result
  • Build result ordinal (0=Stable, 1=Unstable, 2=Failure, 3=Not built, 4=Aborted, 5=Unknown (for pipelines))
  • Successful build boolean
  • Last stable build number (or 0 if never)
  • Last successful build number (or 0 if never)
  • Tests failed (unit test results from JUnit Plugin)
  • Tests skipped (unit test results from JUnit Plugin)
  • Tests total (unit test results from JUnit Plugin)
  • Time in queue (from Metrics plugin)
  • Build scheduled time
  • Build start time
  • Build measured time

JUnit Plugin

Metrics Plugin

cobertura_data
  • Package coverage %
  • Class coverage %
  • Line coverage %
  • Branch coverage %
  • Amount of packages
  • Amount of source files
  • Amount of classes
Cobertura Plugin
rf_results
  • Test case name
  • Suite name
  • Duration
  • Amount of suites
  • Amount of passed tests
  • Amount of failed tests
  • Amount of total tests
  • Pass percentage of all tests
  • Amount of passed critical tests
  • Amount of failed critical tests
  • Total amount of critical tests
  • Pass percentage of critical tests
Robot Framework Plugin
suite_result

Same as rf_results except:

  • Pass percentage of all tests
  • Pass percentage of critical tests
  • Test case name
Robot Framework Plugin
tag_point

Same as rf_results except:

  • Pass percentage of all tests
  • Pass percentage of critical tests
  • Test case name
  • Suite name
  • Amount of suites

Extra data sent for this measurement:

  • Tag name
Robot Framework Plugin
testcase_point

Same as rf_results except:

  • Amount of suites
  • Amount of total tests
  • Pass percentage of critical tests
  • Total amount of critical tests
  • Pass percentage of all tests
Robot Framework Plugin
jacoco_data
  • Package coverage %
  • Class coverage %
  • Line coverage %
  • Branch coverage %
  • Method coverage %
  • Instruction coverage %
JaCoCo Plugin
performance_data
  • Total amount of errors
  • Percentage of errors
  • Average sample duration
  • Max/min sample duration
  • Size of samples
  • Total count of samples
  • 90 percentile
Performance Plugin

sonarqube_data

  • Amount of major/minor/critical/blocker/info issues
  • Lines of code
  • Build display name
-
changelog_data
  • Affected files
  • Commit authors
  • Commit messages
  • Commit count
-
perfpublisher_summary
  • Number of total/executed/not-executed/passed/failed/success/true-false tests
  • Best compile time test value/name
  • Worst compile time test value/name
  • Average compile time
  • Best performance test value/name
  • Worst performance test value/name
  • Average performance
  • Best execution time test value/name
  • Worst execution time test value/name
Perfpublisher Plugin
perfpublisher_metric
  • Metric name
  • Average value for metric
  • worst value for metric
  • best value for metric
Perfpublisher Plugin
perfpublisher_test
  • Test name
  • Was test successful/executed
  • Test message
  • Compile time
  • Execution time
  • Performance
Perfpublisher Plugin
perfpublisher_test_metric
  • Test name
  • Metric name/value/relevancy
Perfpublisher Plugin

Configuration

Create a database in InfluxDB and a user with access rights. In Jenkins, go to Manage Jenkins > Configure System > InfluxDB Targets and click "Add". Provide the database information. The "URL" parameter requires the whole URL of the InfluxDB database, including the http:// and the database port. Also, provide the retention policy you want the data to be stored in InfluxDB (e.g. 15m or 2d for 15 minutes or 2 days respectively). By default, the retention policy is infinite. Exceptions generated by the InfluxDB plugin can also be ignored by unselecting the "Expose Exceptions" checkbox.

In your job, select "Publish build data to InfluxDB" from the post-build actions.

Select the InfluxDB target you wish to publish the data to.

Pipelines

The plugin can be called either by using the influxDbPublisher() or step function. The influxDbPublisher format is only supported from version 1.21 onwards.

influxDbPublisher(selectedTarget: 'myTarget'[, any other parameters you want to use])
step([$class: 'InfluxDbPublisher',
		selectedTarget: 'myTarget',
        customData: null,								// OPTIONAL
        customDataMap: null,							// OPTIONAL
        customPrefix: null,								// OPTIONAL
		jenkinsEnvParameterTag: 'KEY=' + env.PARAM,		// OPTIONAL, custom tags
		jenkinsEnvParameterField: 'KEY=' + env.PARAM,   // OPTIONAL, custom fields
		measurementName: 'myMeasurementName',           // OPTIONAL, custom measurement name. Replaces default "jenkins_data" and "jenkins_custom_data"
		replaceDashWithUnderscore: true,                // OPTIONAL, replace "-" with "_" for tag names. Default=false
	])

customData and customDataMap are custom data generated during the build and not by the plugin.

customPrefix is added to the beginning of the measurements.

target takes the value of your description in your Global configuration.

NOTE! Up to release 1.10.3, pipeline was configured with the use the url and database.

step([$class: 'InfluxDbPublisher',
        customData: null,
        customDataMap: null,
        customPrefix: null,
        target: 'http://127.0.0.1:8086,jenkins_db',
    ])

This form of configuration is not supported from version 1.11 onwards.


Pipelines don't have post-build actions, so the build result, build ordinal, and the build success boolean must be set manually. They will default to "?", 5, and false respectively unless set before calling the step. The boolean value is set according to the ordinal value and the ordinal value is fetched according to build result, so only the build result have to be set manually. Also, the build status will appear as "?" and the build duration might be a little off, because the build is not actually finished. If you want to get those pieces of information you need to configure the plugin separately on each job as a post-build action. The jobs can be run with, for example, the Build Pipeline Plugin to get data from all jobs to InfluxDB. Alternatively, you can insert the information in your build manually inside your Groovy script.

try {
    // Build things here
    if (currentBuild.result == null) {
        currentBuild.result = 'SUCCESS'	// sets the ordinal as 0 and boolean to true
    }
} catch (err) {
    if (currentBuild.result == null) {
        currentBuild.result = 'FAILURE'	// sets the ordinal as 4 and boolean to false
    }
    throw err
} finally {
    influxDbPublisher selectedTarget: 'myTarget'
}


From version 1.19 onwards, it's also possible to create and remove targets in pipelines.

// Get InfluxDB plugin descriptor (version < 2.0)
def influxdb = Jenkins.instance.getDescriptorByType(jenkinsci.plugins.influxdb.DescriptorImpl)

// version >= 2.0
def influxdb = Jenkins.instance.getDescriptorByType(jenkinsci.plugins.influxdb.InfluxDbStep.DescriptorImpl)

// Create target
def target = new jenkinsci.plugins.influxdb.models.Target()

// Set target details
// Mandatory fields
target.description = 'myNewTarget'
target.url = 'http://influxdburl:8086'
target.username = 'myUsername'

// version < 2.0
target.password = 'myPassword'

// version >= 2.0
hudson.util.Secret password = hudson.util.Secret.fromString('myPassword')
target.password = password

target.database = 'myDatabase'

// Optional fields
target.exposeExceptions = true // default = true
target.jobScheduledTimeAsPointsTimestamp = true // default = false
target.usingJenkinsProxy = true // default = false
target.retentionPolicy = '1d' // default = 'autogen'
// NEW in version 1.20.1
target.replaceDashWithUnderscore = true // default = false

// Add a target by using the created target object
influxdb.addTarget(target)
influxdb.save()

// Write stuff to InfluxDB
// NOTE! If you have more targets configured in Jenkins, it's safer to add "selectedTarget" parameter to the InfluxDB step to ensure
// data is sent to the correct target.
// step([$class: 'InfluxDbPublisher', selectedTarget: 'myNewTarget'])
// OR (version >= 2.0)
// influxDbPublisher selectedTarget: 'myNewTarget'

// Remove a target by using the target description field value
influxdb.removeTarget('myNewTarget')
influxdb.save()

Custom Data

You can create custom data in Jenkins pipelines. Custom data can be written to Influx like this:

def myDataMap = [:]
myDataMap['myKey'] = 'myValue'
step([$class: 'InfluxDbPublisher', selectedTarget: 'myTarget', customData: myDataMap])

This adds the key myKey with a value myValue to a measurement called jenkins_custom_data.

You can also create your own measurements with customDataMaps:

def myDataMap1 = [:]
def myDataMap2 = [:]
def myCustomDataMap = [:]
myDataMap1['myMap1Key1'] = 11 // first value of first map
myDataMap1['myMap1Key2'] = 12 // second value of first map
myDataMap2['myMap2Key1'] = 21 // first value of second map
myDataMap2['myMap2Key2'] = 22 // second value of second map
myCustomDataMap['series1'] = myDataMap1
myCustomDataMap['series2'] = myDataMap2
influxDbPublisher selectedTarget: 'myTarget', customDataMap: myCustomDataMap

This creates measurements series1 and series2 and adds the keys myMap1Key1 and myMap1Key2 with values 11 and 12 respectively to series1; and myMap2Key1 and myMap2Key2 with values 21 and 22 respectively to series2.

You can also set tags for your custom measurements with either customDataTags or customDataMapTags. Tags added with customDataTags are added to the measurement jenkins_custom_data. If you use customDataMapTags you must use the same map keys as the measurement names in customDataMap.

You can also set a custom measurement name for your jenkins_data and jenkins_custom_data measurements. To do this you must add

measurementName: 'measurementName_data'

inside your InfluxDbPublisher build step. This will change the name of your jenkins_data measurement into measurementName_data and jenkins_custom_data into custom_measurmentName_data.

Release catalogue

2.0.1 (29.8.2019)

2.0 (23.8.2019)

1.23 (28.6.2019)

1.22 (31.5.2019)

1.21 (16.5.2019)

1.20.4 (20.2.2019)

1.20.3 (5.2.2019)

1.20.2 (14.12.2018)

1.20.1 (29.11.2018)

1.20 (4.10.2018)

1.19 (5.9.2018)

1.18 (15.8.2018)

1.17 (29.6.2018)

1.16 (4.6.2018)

1.15 (11.5.2018)

1.14 (13.2.2018)

1.13.2 (23.1.2018)

1.13.1 (20.12.2017)

1.13 (20.12.2017)

1.12.3 (30.6.2017)

1.12.2 (21.6.2017)

1.12.1 (26.5.2017)

1.12 (15.5.2017)

1.11 (22.3.2017)

1.10.3 (10.2.2017)

1.10.2 (17.1.2017)

1.10.1 (30.12.2016)

1.10 (23.12.2016)

1.9 (8.11.2016)

1.8.1 (28.9.2016)

1.8 (13.9.2016)

1.7 (1.9.2016)

1.6 (10.8.2016)

1.5 (5.8.2016)

1.4 (4.8.2016)

1.3 (26.7.2016)