A dashboard for Graphite
JavaScript Ruby
Switch branches/tags
Nothing to show
Pull request Compare This branch is 137 commits behind ripienaar:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.



A simple Graphite dashboard built using Twitters Bootstrap.

Adding new dashboards is very easy and individual graphs is described using a small DSL.

See the sample directory for an example dashboard including a screenshot.


This dashboard is a Sinatra application, I suggest deploying it in Passenger or other Sinatra application server.

A sample gdash.yaml-sample is included, you should rename it to gdash.yaml and adjust the url to your Graphite etc in there.

The SinatraApp class take two required arguments:

* Where graphite is installed
* The directory that has your _dashboards_ directory full of templates

and additional options:

* The title to show at the top of your Graphite
* A prefix to prepend to all URLs in the dashboard
* How many columns of graphs to create, 2 by default.
* How often dashboard page is refreshed, 60 sec by default.
* The width of the graphs, 500 by default
* The height of the graphs, 250 by default
* Where your whisper files are stored - future use

Creating Dashboards?

You can have multiple top level categories of dashboard. Just create directories in the templatedir for each top level category.

In each top level category create a sub directory with a short name for each new dashboard.

You need a file called dash.yaml for each dashboard, here is a sample:

:name: Email Metrics
:description: Hourly metrics for the email system

Then create descriptions in files like cpu.graph in the same directory, here is a sample:

title       "Combined CPU Usage"
vtitle      "percent"
area        :stacked
description "The combined CPU usage for all Exim Anti Spam servers"

field :iowait, :scale => 0.001,
               :color => "red",
               :alias => "IO Wait",
               :data  => "sumSeries(derivative(mw*munin.cpu.iowait))"

field :system, :scale => 0.001,
               :color => "orange",
               :alias => "System",
               :data  => "sumSeries(derivative(mw*.munin.cpu.system))"

field :user, :scale => 0.001,
             :color => "yellow",
             :alias => "User",
             :data  => "sumSeries(derivative(mw*.munin.cpu.user))"

The dashboard will use the description field to show popup information bubbles when someone hovers over a graph with their mouse for 2 seconds.

The graphs are described using a DSL that has its own project and documented over at https://github.com/ripienaar/graphite-graph-dsl/wiki

At the moment we do not support the Related Items feature of the DSL.

Template Directory Layout?

The directory layout is such that you can have many groupins of dashboards each with many dashboards underneath it, an example layout of your templates dir would be:

`-- virtualization
    |-- dom0
    |   |-- dash.yaml
    |   |-- iowait.graph
    |   |-- load.graph
    |   |-- system.graph
    |   |-- threads.graph
    |   `-- user.graph
    `-- kvm1
	|-- dash.yaml
	|-- disk_read.graph
	|-- disk_write.graph
	|-- ssd_read.graph
	`-- ssd_write.graph

Here we have a group of dashboards called 'virtualization' with 2 dashboards inside it each with numerous graphs.

You can create as many groups as you want each with many dashboards inside.

Time Intervals Display?

If you configure time intervals in the config file you can click on any graph in the main dashboard view and get a view with different time intervals of the same graph

    - [ "-1hour", "1 hour" ]
    - [ "-2hour", "2 hour" ]
    - [ "-1day", "1 day" ]
    - [ "-1month", "1 month" ]
    - [ "-1year", "1 year" ]

With this in place in the config.yaml clicking on a graph will show the 5 intervals defined above of that graph

Full Screen Displays?

You can reuse your dashboards for big displays against a wall in your NOC or office by using the following url structure:


This will display the email dashboard in 4 columns each graph with a width of 600 and a height of 300

The screen will refresh every minute


R.I.Pienaar / rip@devco.net / http://www.devco.net/ / @ripienaar