Skip to content
This repository

Visualize your team's metrics all in one place.

branch: master
Octocat-spinner-32 app Merge pull request #126 from aberrios85/patch-1 February 23, 2014
Octocat-spinner-32 config fix asset minification on production December 30, 2013
Octocat-spinner-32 db update mysql2, therubyracer, uglifier gems October 29, 2013
Octocat-spinner-32 doc initial March 04, 2012
Octocat-spinner-32 gh-pages add small versino July 20, 2012
Octocat-spinner-32 lib rename stacked to area graph #110) November 09, 2013
Octocat-spinner-32 log initial March 04, 2012
Octocat-spinner-32 public initial March 04, 2012
Octocat-spinner-32 script initial March 04, 2012
Octocat-spinner-32 spec change config keys to more easily map to ENV vars December 30, 2013
Octocat-spinner-32 vendor upgrade to rails4 October 29, 2013
Octocat-spinner-32 .gitignore add secrets.yml to source control December 30, 2013
Octocat-spinner-32 .rspec use rspec and fix tests June 26, 2012
Octocat-spinner-32 .ruby-version update to ruby 2.0.0 December 29, 2013
Octocat-spinner-32 .travis.yml update to ruby 2.0.0 December 29, 2013
Octocat-spinner-32 API.markdown version2 release candidate, full changelog will follow soonish! March 04, 2013
Octocat-spinner-32 CHANGELOG.md update to ruby 2.0.0 December 29, 2013
Octocat-spinner-32 Gemfile specify ruby v2.0.0 in Gemfile and heroku dependencies December 30, 2013
Octocat-spinner-32 Gemfile.lock specify ruby v2.0.0 in Gemfile and heroku dependencies December 30, 2013
Octocat-spinner-32 Guardfile initial setup to run headless #25 September 09, 2012
Octocat-spinner-32 HTTP_PROXY.markdown migrated plugins to this repo, docs updated March 16, 2013
Octocat-spinner-32 Procfile port configurable April 03, 2013
Octocat-spinner-32 README.markdown change config keys to more easily map to ENV vars December 30, 2013
Octocat-spinner-32 Rakefile use karma (with jasmine) for javascript testing October 19, 2013
Octocat-spinner-32 SOURCE_PLUGINS.markdown change config keys to more easily map to ENV vars December 30, 2013
Octocat-spinner-32 VERSION2_MIGRATION.markdown update docs March 27, 2013
Octocat-spinner-32 WIDGETS.markdown simplified widget plugin code/docs March 23, 2013
Octocat-spinner-32 WIDGETS_CONFIGURATION.markdown document common parameters #144 November 09, 2013
Octocat-spinner-32 config.ru rename to team dashboard June 21, 2012
Octocat-spinner-32 karma.conf.js use karma (with jasmine) for javascript testing October 19, 2013
Octocat-spinner-32 package.json use karma (with jasmine) for javascript testing October 19, 2013
README.markdown

Team Dashboard

Team Dashboard lets you visualize your team's metrics all in one place (see Screenshots). It is build to be shown on a big screen in your team's space.

Heroku hosted Demo

It has built-in support for Graphite, Ganglia, Jenkins, Travis CI, Errbit, New Relic, Pingdom, Sensu and more and makes it really easy to add more data sources.

It is implemented as a Rails app and uses ActiveRecord to store your custom dashboards configuration.

Support via Team Dashboard Google Group

News

Team Dashboard 2.0.0 is available (March 5, 2013)

The final release is now available. More details in the Changelog!

Team Dashboard 2 RC2 is available (April 14, 2013)

Lots of new features and bugfixes. This is (hopefully) the last release candidate!

Read the Changelog!

Team Dashboard 2 RC1 is available (March 16, 2013)

Please checkout the Changelog and read the Migration Guide.

Getting Started

Debian Stable Prerequisites

Install bundler and the required libraries for gem compilation:

apt-get install bundler libxml2-dev libz-dev libmysqlclient-dev libxslt-dev

Download, install, and start

Clone the repository:

git clone git://github.com/fdietz/team_dashboard.git

Run bundler:

bundle install

On Windows the unicorn gem is not supported (the installation of the kgio gem will fail). But you can use thin instead (see Stack Overflow Issue).

Create a database.yml from the example config. Note, that this will overwrite your existing configuration 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:

rake populate

Start the Rails server:

rails s

or use unicon directly:

bundle exec unicorn -c config/unicorn.rb

Running the build

Run the Rails unit/functional tests:

rake

Run the javascript unit tests (using karma):

karma start

Note, that it requires NodeJS to be installed. There's a package.json provided to install the dependencies using npm install command.

Configuration

System-wide configuration settings reside in config/secrets.yml.

For example when configuring graphite you can see the configuration settings in secrets.yml:

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

Use environment variables in production instead of storing your secret information directly in secrets.yml. When deploying on Heroku you can set these as described in Configuration and Config Vars.

Alternatively, you can decide to remove secrets.yml from source control and instead link to a yml file existing on the production environment only. This is most commonly used when deploying with capistrano.

The configuration was changed to resemble the Rails 4.1 secrets.yml feature in order to support an easy upgrade path.

All data sources reside in app/models/sources and provide source code documentation with further details.

Dashboard Widgets

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.

You can easily add your own data source plugins (Data Source Plugins Developer Guide) and implement custom widgets (Widget Developer Guide).

Available Widgets

Graph Widget

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.

It currently supports Graphite and Ganglia.

Number Widget

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.

It currently supports a New Relic, Hockey App, http proxy data source and Issue counter for Jira Filters.

Boolean Widget

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.

Alert Widget

It is similar to the Boolean Widget. It is designed to show the alerts of your system. The idea behind was introducing a possibility for linking the dashboard with the Sensu monitoring framework and displaying the alerts and the respective messages.

It currently supports Sensu.

CI (Continous Integration Server) Widget

Shows the current build status for a given project.

It currently supports Jenkins and Travis CI.

Exception Tracker Widget

Shows the number of unresolved errors in your exception tracker, and when the last error occurred. It currently supports Errbit.

Status Table Widget

Shows data in a table format with an overall status (like the alert widget) and individual row status with a label and a value.

It currently supports using a json file as input.

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.

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.

Something went wrong with that request. Please try again.