Team Dashboard lets you visualize your team's metrics all in one place. It is build to be shown on a big screen in your team's space.
It is implemented as a Rails app and uses ActiveRecord to store your custom dashboards configuration.
Support via Team Dashboard Google Group
Team Dashboard 2.0.0 is available
The final release is now available. More details in the announcement.
Team Dashboard 2 RC2 is available
Lots of new features and bugfixes. This is (hopefully) the last release candidate!
Read the Changelog
Team Dashboard 2 RC1 is available
Clone the repository:
git clone git://github.com/fdietz/team_dashboard.git
Create a database.yml from the example config (using MySQL):
cp config/database.example.yml config/database.yml
Create the database and run migrations:
rake db:create && rake db:migrate
There is an initial "Demo" source and sample dashboards provided. Generate these via:
Start the Rails server:
Running the build
If you want to run the tests locally, you will need to install PhantomJS
brew update && brew install phantomjs
Run the unit tests (ruby & js)
System-wide configuration settings are done in either
application.rb or with an environment variable.
For example when configuring
graphite you can see the configuration settings in application.rb:
config.graphite_url = ENV['GRAPHITE_URL']
You can either change the configuration there or set the environment variable when starting the rails app:
GRAPHITE_URL=http://localhost:8080 rails s
All data sources reside in
app/models/sources and provide source code documentation with further details.
A dashboard in Team Dashboard consists of multiple Widgets, which request data from a data source via AJAX request.
All widgets have a name, time interval in which to update themselves and a data source as a common configuration.
The graph widget shows a time series line or area graph. Use it to show number of visits on your web page or number of currently online users and follow-up on trends.
Shows the current integer value provided by the data source, the percentage of change compared to the previous value and an optional label. Use it to show for the example the number of errors on specific systems or the number of users.
Shows the current boolean value provided by the data source and an optional label. Use it to show for example the success of a Jenkins build or the health status of a system.
It currently supports Pingdom, arbitrary shell commands and a http proxy data source.
CI (Continous Integration Server) Widget
Shows the current build status for a given project.
Exception Tracker Widget
Shows the number of unresolved errors in your exception tracker, and when the last error occurred. It currently supports Errbit.
Credits & Contributors
Thanks go to Martin Tschischauskas and Marno Krahmer who worked with me on the first iteration which was build as part of a XING Hackathon Project.
- luxflux (Raffael Schmid)
- frankmt (Francisco Trindade)
- leejones (Lee Jones)
- rngtng (Tobias Bielohlawek)
- ndbroadbent (Nathan Broadbent)
- DraganMileski (Dragan Mileski)
- averell23 (Daniel Hahn)
- martintsch (Martin Tschischauskas)
- Marno Krahmer
The MIT License
Copyright (c) 2012 Frederik Dietz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.