- Overview
- What is Wavefront Plugin for Jenkins
- Prerequisites
- Provided metrics
- Configuration
- Contributing
- License
Wavefront offers a real-time metrics monitoring and streaming analytics platform designed for developers to optimize their clouds and modern applications that rely on containers and microservices. A cloud-hosted service, Wavefront offers Digital Enterprises the ability to send time-series (metric) data from anywhere in their data center and to perform queries, render charts to see analytics, anomalies or KPI dashboards. (For more information: Wavefront)
Wavefront Plugin for Jenkins is monitoring plugin which sends different kinds of metrics about Jenkins itself to Wavefront. The plugin provides in-depth information about how the system is working in form of statistics. Using the notification hooks Jenkins provides the plugin sends the metrics as soon as they are available. It removes the need for external monitoring solutions that poll recurrently the system for data as these solutions can lead to degradation of Jenkins performance.
Before installing Wavefront Plugin for Jenkins on your instance you need to install the Wavefront proxy from here
There are 2 kinds of metric data that the plugin process:
- Jenkins system and node label metrics - these are sent periodically every 5 minutes by default. This can be customized from the Wavefront plugin configuration page (See Flush Interval field).
- Job and pipeline metrics - these are sent on job run completion.
Jenkins system and node label metrics are prefixed and sent to Wavefront with wjp and job metrics are prefixed with wjp.job prefix by default. These prefixes can be customized from the Wavefront plugin configuration page.
You can set whether to send JUnit and Jacoco reports from the respective job properties.
Another option is to send job parameters as tags (parameterName=parameterValue) for the following metrics:
- Job metrics
- Junit report
Job parameter tags are prefixed with p_ and are limited to 10 per job execution.
-
Jenkins system – System CPU (This value is a double in the [0.0, 1.0] interval), Total physical memory (in bytes), Free physical memory (in bytes), Max heap memory (in bytes), Used heap memory (in bytes). Metric name: <metric-prefix>.system-cpu. List:
- wjp.system-cpu
- wjp.total-physical-memory
- wjp.free-physical-memory
- wjp.max-heap-memory
- wjp.used-heap-memory
-
Label nodes – For each node label the plugin sends number of available executors, busy executors, connecting executors, defined executors, idle executors, online executors and queue length. Metric name: <metric-prefix>.label.available-executors. List:
- wjp.label.available-executors
- wjp.label.busy-executors
- wjp.label.connecting-executors
- wjp.label.defined-executors
- wjp.label.idle-executors
- wjp.label.online-executors
- wjp.label.queue-length
-
Job metrics – Total duration (in milliseconds) of the job, status and build number. Metric name: <job-metric-prefix>.jobname. Tags: job status, build number. List:
- wjp.job.jobname
-
Pipeline metrics (stages and parallel branches) – In addition to the job metrics, duration (in milliseconds) for each stage and branch in parallel step. Metric name: <job-metric-prefix>.jobname.{stage, parralel}.stagename. Tags: job status, build number. List:
- wjp.job.jobname.stage.stagename
- wjp.job.jobname.parallel.branchname
-
JUnit report – If it's enabled, duration (in milliseconds) for each JUnit test per job (not send by default, needs Jenkins JUnit plugin). Metric name: <job-metric-prefix>.junit.full.path.to.test. Tags: job name, build number, test status. List:
-
wjp.job.junit.com.vmware.plugins.testclass.testingmethod
-
Following metrics are also available at the Job level.
- wjp.job.junit.jobName
- wjp.job.junit.jobName.passcount
- wjp.job.junit.jobName.failcount
- wjp.job.junit.jobName.skipcount
- wjp.job.junit.jobName.totalcount
-
-
Jacoco report – If it's enabled, sends minimum, maximum, covered and total number of instructions-coverage, branch-coverage, complexity-coverage, line-coverage, method-coverage and class-coverage per job (not sent by default, needs Jenkins Jacoco plugin). Metric name: <job-metric-prefix>.jobname.jacoco.line-coverage.minimum. Tags: job status, build number. List:
- wjp.job.jobname.jacoco.instructions-coverage.{minimum, maximum, covered, total}
- wjp.job.jobname.jacoco.branch-coverage.{minimum, maximum, covered, total}
- wjp.job.jobname.jacoco.complexity-coverage.{minimum, maximum, covered, total}
- wjp.job.jobname.jacoco.line-coverage.{minimum, maximum, covered, total}
- wjp.job.jobname.jacoco.method-coverage.{minimum, maximum, covered, total}
- wjp.job.jobname.jacoco.class-coverage.{minimum, maximum, covered, total}
-
Custom step (wavefrontTimedCall) – The wavefrontTimedCall step measure duration (in milliseconds) in given block. Syntax: wavefrontTimedCall(“metricName”) {…}. Metric name: <job-metric-prefix>.step.metricname. Tags: job name, build number. List:
- wjp.job.step.metricname
Plugin can be configured from Jenkins UI.
The plugin can be configured from the Wavefront plugin configuration section under Jenkins management page. From Wavefront proxy configuration section we need to set up:
- Wavefront Proxy hostname and port
- Metric prefixes (see)
- Send metrics recurrence interval
If proxy hostname is not specified (left empty) then no metrics will be sent to Wavefront.
The wavefront-plugin-for-jenkins project team welcomes contributions from the community. Before you start working with wavefront-plugin-for-jenkins, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.
Copyright: Copyright 2015-2019 VMware, Inc. All Rights Reserved.
SPDX-License-Identifier: https://spdx.org/licenses/MIT.html