Skip to content

Instantly share code, notes, and snippets.

@waa

waa/README.md

Last active August 22, 2019 07:06
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save waa/0046ea8f75c46430d4ef84322a978f11 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save waa/0046ea8f75c46430d4ef84322a978f11 to your computer and use it in GitHub Desktop.
Download ZIP
Bacula Status widget for the Smashing Dashboard
Raw
README.md

This is a widget for the Smashing dashboard. It displays quite a bit of statistics about your Bacula backup server environment.

Preview

Prerequisites

It should be opbvious, but you will need a fully functional Bacula (community or enterprise edition) installation. This widget makes use of the Bacula command line tool called bconsole to query the Director for information, then sends the data to the Smashing server via curl.

Installation

Copy the smashing-BaculaStatus.sh bash shell script to any directory you like. It may be somewhere on the smashing server, on the Bacula Director, or any machine where cron is available. Near the top of this file, edit the variables to match your system. You will need to create a bconsole-smashing.conf file, and the information (password etc) in this file will need to match a console section in the Director's "bacula-dir.conf" config file. (see examples below)

bacula-dir.conf

Here is a snippet of a Console resource in the bacula-dir.conf file which will restrict our widget to just being able to query the status of the Director and list jobs. After editing the bacula-dir.conf file, type reload in bconsole or restart the Director:

Console {
  Name = smashing
  Password = "dpvCLchbz0I4/tf5HAB8sN0z"  # Some pseudo random password
  CatalogACL = MyCatalog                 # Set this to the name of your Bacula catalog database
  CommandACL = status, list              # Only allow "status" and "list" commands
  JobACL = *all*                         # Allow "status director" command to show all jobs
}

bconsole-smashing.conf

Director {
  Name = bacula-dir            # Set this to the name of your Bacula director
  DIRport = 9101
  Address = bacula.example.com # IP address or FQDN of your Bacula Director
  Password = ""                # Not used, so it may be blank 
}

Console {
  Name = smashing                         # Must match the name of the Console in the bacula-dir.conf
  Password = "dpvCLchbz0I4/tf5HAB8sN0z"   # Must match the Console's Password in the bacula-dir.conf above
  Director = bacula-dir                   # Must match the Name of the Director in this file just above
}

Testing bconsole connectivity

At this point, we should be able to connect to the Director with bconsole using the bconsole-smashing.conf configuration file and type the "list jobs" and "status director" commands that the widget will use:

$ bconsole -c /path/to/bconsole-smashing.conf
Connecting to Director bacula.example.com:9101
1000 OK: 103 bacula-dir Version: 9.0.3 (08 August 2017)
Enter a period to cancel a command.
* status director
bacula-dir Version: 9.0.3 (08 August 2017) x86_64-pc-linux-gnu gentoo 
Daemon started 23-Sep-17 13:12, conf reloaded 23-Sep-2017 13:12:52
 Jobs: run=0, running=0 mode=0,0
 Heap: heap=389,120 smbytes=489,382 max_bytes=499,788 bufs=3,324 max_bufs=3,331
 Res: njobs=69 nclients=22 nstores=4 npools=13 ncats=1 nfsets=36 nscheds=12

Scheduled Jobs:
Level          Type     Pri  Scheduled          Job Name           Volume
===================================================================================
Admin          Admin      5  23-Sep-17 20:00    UpdateSlots        
Incremental    Backup    10  23-Sep-17 20:00    pi                 c0_0004_0066
Incremental    Backup    10  23-Sep-17 20:00    jabber             c0_0004_0066
Incremental    Backup    10  23-Sep-17 20:00    dns1               c0_0004_0066
Incremental    Backup    10  23-Sep-17 20:00    helpdesk           c0_0004_0066
[...]
Running Jobs:
Console connected at 23-Sep-17 13:12
No Jobs running.
====

Terminated Jobs:
 JobId  Level      Files    Bytes   Status   Finished        Name 
====================================================================
 16833  Incr          20    15.29 M  OK       23-Sep-17 01:20 pi
 16834  Admin          0         0   OK       23-Sep-17 01:20 UpdateSlots
 16835  Full     681,136    45.60 G  OK       23-Sep-17 04:29 Zimbra8
 16837  Restore      120    6.911 G  OK       23-Sep-17 04:46 RestoreCatalog
[...]

And now test the "list jobs" command:

*list jobs limit=10
Automatically selected Catalog: MyCatalog
Using Catalog "MyCatalog"
+-------+-------------+---------------------+------+-------+----------+----------+-----------+
| jobid | name        | starttime           | type | level | jobfiles | jobbytes | jobstatus |
+-------+-------------+---------------------+------+-------+----------+----------+-----------+
| 9,730 | SpeedyVMs   | 2016-06-21 20:00:00 | B    | I     |        0 |        0 | T         |
| 9,743 | SpeedyMusic | 2016-06-22 20:00:01 | B    | I     |        0 |        0 | T         |
[...]

Dashboard entry

Add the following to your dashboard.erb file:

<li data-row="1" data-col="1" data-sizex="1" data-sizey="2">
  <div data-id="bacula" data-view="Bacula" data-title="Bacula Backups" data-runningjobs="Waiting on update" data totaljobs="Waiting on update" data-firstlast="Waiting on update" data-goodjobs="Waiting on update" data-problemjobs="Waiting on update" data-incompletejobs="Waiting on update" data-adminjobs="Waiting on update" data-verifyjobs="Waiting on update" data-restorejobs="Waiting on update" data-totalfiles="Waiting on update" data-totalbytes="Waiting on update">
  </div>
</li>

Widget files

  • Copy the bacula.coffee, bacula.html, and bacula.scss to widgets/bacula
  • Copy the smashing-BaculaStatus.sh script somehere, and set it executable:
    • # chmod +x smashing-BaculaStatus.sh
  • Edit the system variables at the top of the smashing-BaculaStatus.sh script

cron job

  • Add the following line you your cron scheduler. This example will run the script every 30 minutes:
*/30 * * * * /path/to/smashing-BaculaStatus.sh      # Of course, use the correct path here :)

Enjoy!

Please let me know if there is something terrribly wrong with this widget. It is my first one, and I am sure it can use some enhancements, or fixes.

Raw
bacula-html
<h1 class="title" data-bind="title"></h1>
<hr>
<h3 data-bind="runningjobs"></h3>
<h3 data-bind="totaljobs"></h3>
<h3 data-bind="firstlast"></h3>
<h3 data-bind="goodjobs"></h3>
<h3 data-bind="problemjobs"></h3>
<h3 data-bind="incompletejobs"></h3>
<hr>
<h3 data-bind="adminjobs"></h3>
<h3 data-bind="verifyjobs"></h3>
<h3 data-bind="restorejobs"></h3>
<hr>
<h3 data-bind="totalfiles"></h3>
<h3 data-bind="totalbytes"></h3>
<p class="updated-at" data-bind="updatedAtMessage"></p>
Raw
bacula.coffee
class Dashing.Bacula extends Dashing.Widget
ready: ->
# This is fired when the widget is done being rendered
onData: (data) ->
# Handle incoming data
# You can access the html node of this widget with `@node`
# Example: $(@node).fadeOut().fadeIn() will make the node flash each time data comes in.
# $(@node).fadeOut().fadeIn()
Raw
bacula.scss
.widget-bacula {
background: #ca1108;
font-size: 30px;
}
Raw
smashing-BaculaStatus.sh
#!/bin/bash
#
# smashing-BaculaStatus.sh
#
# ------------------------------------------------------------------------------
#
# waa - 20170923 - Initial release. Full changlog at bottom of script
#
# ------------------------------------------------------------------------------
#
# Copyright (c) 2017, William A. Arlofski waa-at-revpol-dot-com
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# ------------------------------------------------------------------------------
# System variables
# ----------------
bc="/usr/sbin/bconsole"
bcconfig="/path/to/bconsole-smashing.conf"
http="http" # http or https
smashinghost="smashing.example.com"
smashingport="3030"
smashingauthtoken="xyz123"
smashingwidget="bacula"
# --------------------------------------------------
# Nothing should need to be modified below this line
# --------------------------------------------------
# Get data from Bacula Director
# -----------------------------
runningjobs=$(printf "%'d\n" $(echo "status director" \
| ${bc} -c ${bcconfig} \
| awk "BEGIN {} /^Running.*/,/^Terminated/ {print}" \
| grep "^ \+[0-9]" | wc -l))
totaljobs=$(printf "%'d\n" $(echo "list jobs" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
firstjob=$(echo "list jobs" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | head -n 1 | cut -d '|' -f2 | tr -d ' ')
lastjob=$(echo "list jobs" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | tail -n 1 | cut -d '|' -f2 | tr -d ' ')
goodjobs=$(printf "%'d\n" $(echo "list jobs jobstatus=T" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
failedjobs=$(echo "list jobs jobstatus=f" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l)
abortedjobs=$(echo "list jobs jobstatus=A" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l)
errorjobs=$(echo "list jobs jobstatus=E" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l)
diffjobs=$(echo "list jobs jobstatus=D" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l)
incompletejobs=$(printf "%'d\n" $(echo "list jobs jobstatus=I" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
problemjobs=$(printf "%'d\n" $(echo "${failedjobs} + ${abortedjobs} + ${errorjobs} + ${diffjobs} + ${incompletejobs}" | bc))
adminjobs=$(printf "%'d\n" $(echo "list jobs jobtype=D" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
verifyjobs=$(printf "%'d\n" $(echo "list jobs jobtype=V" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
restorejobs=$(printf "%'d\n" $(echo "list jobs jobtype=R" | ${bc} -c ${bcconfig} | grep "^| \+[0-9]" | wc -l))
totalfiles=$(printf "%'d\n" $(echo "list jobs jobtype=B" | ${bc} -c ${bcconfig} | tr -d , | grep "^| \+[0-9]" | awk '{print $13}' | paste -sd+ - | bc))
totalbytes=$(echo "list jobs jobtype=B" | ${bc} -c ${bcconfig} | tr -d , | grep "^| \+[0-9]" | awk '{print $15}' | paste -sd+ - | bc | numfmt --to=iec --suffix=B)
# Send data to smashing server
# ----------------------------
curl -s -d "{ \"auth_token\": \"${smashingauthtoken}\", \
\"runningjobs\": \"Running Jobs: ${runningjobs}\", \
\"totaljobs\": \"Total Jobs: ${totaljobs}\", \
\"firstlast\": \"First/Last: ${firstjob}/${lastjob}\", \
\"goodjobs\": \"Good Jobs: ${goodjobs}\", \
\"problemjobs\": \"Problem Jobs: ${problemjobs}\", \
\"incompletejobs\": \"Incomplete Jobs: ${incompletejobs}\", \
\"adminjobs\": \"Admin Jobs: ${adminjobs}\", \
\"verifyjobs\": \"Verify Jobs: ${verifyjobs}\", \
\"restorejobs\": \"Restore Jobs: ${restorejobs}\", \
\"totalfiles\": \"Files: ${totalfiles}\", \
\"totalbytes\": \"Bytes: ${totalbytes}\" }" \
${http}://${smashinghost}:${smashingport}/widgets/${smashingwidget}
# -------------
# End of script
# -------------
# ----------
# Change Log
# ----------
# ----------------------------
# William A. Arlofski
# Reverse Polarity, LLC
# [email protected]
# http://www.revpol.com/bacula
# ----------------------------
#
#
# 20170923 - Initial release
#
# -------------------------------------------------------------------------------
# I like small tabs. Use :set list in vim to see tabbing etc
# vim: set tabstop=2:softtabstop=2:shiftwidth=2 #
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment