Skip to content

Instantly share code, notes, and snippets.

Forked from steintore/
Last active March 11, 2023 09:22
Show Gist options
  • Save mavimo/6334816 to your computer and use it in GitHub Desktop.
Save mavimo/6334816 to your computer and use it in GitHub Desktop.


Dashing widget to display a Jenkins build status and build progress

The widget is based on the meter-widget which is default in the Dashing installation

The widget can also see the progress of a "pre-build", i.e if you have a job triggering the actual build you want to define, you can configure this job in the jenkins_build.rb as a prebuild.

For more information, please see Coding Like a tosser


Put the files, jenkins_build.html and jenkins_build.scss goes in the /widget/jenkins_build directory and the jenkins_build.rb in the /jobs directory

Otherwise you can install this plugin typing:

dashing install GIST_ID

Usage (jenkins_build.rb)

Change the JENKINS_URI to your correct uri for Jenkins, eg.:

JENKINS_URI = URI.parse("")

Add jenkins credential (if required) in JENKINS_AUTH, eg.:

  'name' => 'username',
  'password' => 'password'

Put all the jobnames and pre job names in the job_mapping, eg.:

job_mapping = {
  'job1' => { :job => 'Job Name 1'},
  'job2' => { :job => 'Job Name 2', :pre_job => 'Job Name 3'},

Put the following in your dashingboard.erb file to show the status:

<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
  <div data-id="job1" data-view="JenkinsBuild" data-title="Build title" data-description="A little description of build" data-min="0" data-max="100"></div>

Multiple jobs can add in dashboard repeating the snippet and changing data-id in accord with job name specified in job_mapping. Widget support title and description via data attributes, this attributest can be omitted if you do not like to display this information.

class Dashing.JenkinsBuild extends Dashing.Widget
@accessor 'value', Dashing.AnimatedValue
@accessor 'bgColor', ->
if @get('currentResult') == "SUCCESS"
else if @get('currentResult') == "FAILURE"
else if @get('currentResult') == "PREBUILD"
constructor: ->
@observe 'value', (value) ->
ready: ->
meter = $(@node).find(".jenkins-build")
$(@node).fadeOut().css('background-color', @get('bgColor')).fadeIn()
meter.attr("data-bgcolor", meter.css("background-color"))
meter.attr("data-fgcolor", meter.css("color"))
onData: (data) ->
if data.currentResult isnt data.lastResult
$(@node).fadeOut().css('background-color', @get('bgColor')).fadeIn()
<h2 class="title" data-bind="title"></h2>
<input class="jenkins-build" data-angleOffset=-125 data-angleArc=250 data-width=200 data-readOnly=true data-bind-value="value | shortenedNumber" data-bind-data-min="min" data-bind-data-max="max">
<p class="more-info" data-bind="description"></p>
<p class="last-built" data-bind="lastBuilt"></p>
<p class="updated-at" data-bind="updatedAtMessage"></p>
require 'net/http'
require 'json'
require 'time'
JENKINS_URI = URI.parse("http://localhost:8080")
'name' => nil,
'password' => nil
# the key of this mapping must be a unique identifier for your job, the according value must be the name that is specified in jenkins
job_mapping = {
'JOB' => { :job => 'BUILD', :pre_job => 'PRE_BUILD'}
def get_number_of_failing_tests(job_name)
info = get_json_for_job(job_name, 'lastCompletedBuild')
def get_completion_percentage(job_name)
build_info = get_json_for_job(job_name)
prev_build_info = get_json_for_job(job_name, 'lastCompletedBuild')
return 0 if not build_info["building"]
last_duration = (prev_build_info["duration"] / 1000).round(2)
current_duration = ( - build_info["timestamp"] / 1000).round(2)
return 99 if current_duration >= last_duration
((current_duration * 100) / last_duration).round(0)
def get_json_for_job(job_name, build = 'lastBuild')
job_name = URI.encode(job_name)
http =, JENKINS_URI.port)
request ="/job/#{job_name}/#{build}/api/json")
if JENKINS_AUTH['name']
request.basic_auth(JENKINS_AUTH['name'], JENKINS_AUTH['password'])
response = http.request(request)
job_mapping.each do |title, jenkins_project|
current_status = nil
SCHEDULER.every '10s', :first_in => 0 do |job|
last_status = current_status
build_info = get_json_for_job(jenkins_project[:job])
current_status = build_info["result"]
if build_info["building"]
current_status = "BUILDING"
percent = get_completion_percentage(jenkins_project[:job])
elsif jenkins_project[:pre_job]
pre_build_info = get_json_for_job(jenkins_project[:pre_job])
current_status = "PREBUILD" if pre_build_info["building"]
percent = get_completion_percentage(jenkins_project[:pre_job])
send_event(title, {
currentResult: current_status,
lastResult: last_status,
timestamp: build_info["timestamp"],
value: percent
// ----------------------------------------------------------------------------
// Sass declarations
// ----------------------------------------------------------------------------
$background-color: #4b5f24;
$title-color: rgba(255, 255, 255, 1);
$moreinfo-color: rgba(255, 255, 255, 0.7);
$meter-background: rgba(20, 20, 20, 1);
// ----------------------------------------------------------------------------
// Widget-jenkins-build styles
// ----------------------------------------------------------------------------
.widget-jenkins-build {
background-color: $background-color;
input.jenkins-build {
background-color: $meter-background;
color: #fff;
.title {
color: $title-color;
.more-info {
color: $moreinfo-color;
.updated-at {
color: rgba(0, 0, 0, 1);
Copy link

rdohms commented Oct 11, 2013

You have a bug here:

This line should read request ="/job/#{job_name}/#{build}/api/json")

Otherwise you get "undefined method `set_body_internal’ for #" errors.

Copy link

TIP: If you're accessing Jenkins via https, you'll also need to add the following two lines immediately following request ="/job/#{job_name}/#{build}/api/json"):
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

Copy link

bitle commented Feb 25, 2014

Can you add screenshots please?

Copy link

bhaku commented Mar 6, 2014

Can you correct the error found by @rdohms ?

Copy link

mavimo commented Oct 31, 2014

@bhaku @rdohms fixed.

Copy link

Anyone have any tips about how to narrow this down to a single widget that indicates if there are any current build failures? We have about 30 active projects and trying to watch them all in one page... the widgets are too big to see them all at a glance. We really only need to have a single high level indication of any fails... which will alert us to investigate further. Thanks, Chris.

Copy link

@TinajaLabs I just added our Jenkins Build Status widget which does exactly what you want.

Copy link

ghost commented May 5, 2015

I still cannot get this to work when using HTTPS for jenkins. I just get a widget displayed with 0

Copy link

If Jenkins has his own context and uses https you have to replace get_json_for_job with:

def get_json_for_job(job_name, build = 'lastBuild')
  job_name = URI.encode(job_name)
  http =, JENKINS_URI.port)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  request = + "/job/#{job_name}/#{build}/api/json")
  if JENKINS_AUTH['name']
    request.basic_auth(JENKINS_AUTH['name'], JENKINS_AUTH['password'])
  response = http.request(request)

Copy link

check your dashingboard.erb and make sure <div data-id="job1" matches the job name in jenkins_build.rb job_mapping = {

code says JOB but the example at the tope says job1

Copy link

The "Coding like a tosser" link is no longer valid

Copy link

Hi guys, can anyone suggest how to show recent 10 changes in a specific job in jenkins to dashing

Copy link

ghost commented Jul 31, 2017

Copy link

Radeel18 commented Aug 4, 2021

Hey, great job it helps alot!
The only problem is that our jenkins is pretty busy and gets overwhelmed by the number of requests. We shortened your code a bit so we now have one request per job but the problem is still the same.
Is there a way to get information for multiple jobs out of a single request?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment