This is the warboard we use internally at Dogsbody Technology Ltd. The backend is all written in Python and the frontend is Python (Flask) using the Jinja2 templating engine. The Warboard is a dashboard that can be displayed on a screen to show the current status of operations using Pingdom, NewRelic, TICK, Prometheus, Sirportly & Google Calendar as sources.
Modules are intended to be modular however this is not yet really the case. We would like to allow users to provide credentials for any number of the services and have a working warboard however there are some modules that need at least an empty dictionary to loop through and others that are required. When updating it is worth checking code changes particularly if they are to config.sample.py as config updates may well be required.
The warboard requires you have redis-server, python, python-virtualenv, python-dev, libffi-dev & libssl-dev installed:
sudo apt-get install redis-server python python-virtualenv python-dev libffi-dev libssl-dev
Once you have these installed you can create the log directory and a virtual environment and install the required python modules in the environment:
mkdir logs
virtualenv venv
. venv/bin/activate
pip install -r requirements.txt
You will also need to setup some filters in sirportly and record their ID's in your config.py file, first of all copy the config.sample.py file to config.py.
We are using an internal filter as green here, where the internal status_type is open
The Warboard will also be set to ignore low priority tickets, due to them being the greatest numerical priority Priority is less then low will be used a lot.
The following filters are required:
-
sirportly_unassigned_filter (Matches all these conditions: Assigned user is blank, Status type is not closed, Priority is less than low))
-
sirportly_resolved_filter (Matches all these conditions: Status type is closed)
-
sirportly_red_filter (Matches all these conditions: Status type is open, Priority is less than low, Status is not internal)
-
sirportly_blue_filter (Matches all these conditions: Status type is open, Priority is less than low, Status type is on hold)
-
sirportly_total_filter (Matches all these conditions: Status type is not closed, Priority is less than low)
-
sirportly_reduser_filter (Matches all these conditions: Assigned user is current user, Priority is less than low, Status type is open, Status is not internal)
-
sirportly_blueuser_filter (Matches all these conditions: Assigned user is current user, Priority is less than low, Status type is on hold)
-
sirportly_greenuser_filter (Matches all these conditions: Assigned user is current user, Priority is less than low, Status is internal)
The rest of the settings in the config file should also be filled out, the required values should be pretty self explanatory with the examples in the sample config file. Support will be added in the future for enabling and disabling different parts of the Warboard (Pingdom, NewRelic, Sirportly etc).
Once the config file has been correctly created you will need to start the daemon that fetches all the data from the relevant API's. This must be done as the user specified in config.py. You can do this with the following command:
/home/warboard/app/venv/bin/python /home/warboard/app/daemon.py start|stop|restart
The only other thing you will need to do is setup a cron running as the warboard user. The cron should contain the following (change the paths if applicable):
00 * * * * /home/warboard/app/venv/bin/python /home/warboard/app/modules/tasks.py hourly
This cron will run the hourly tasks such as grabbing the latest calendar items from the Google Calendar export. You can test the warboard in a dev environment by just running the main.py file in the virtual environment. In production nginx & uwsgi should be used.
When making any changes to the config file, such as removing Pingdom/Newrelic accounts you are required to restart the daemon and reload uwsgi. This can be done with the following:
sudo service uwsgi reload
/home/warboard/app/venv/bin/python /home/warboard/app/daemon.py restart