Skip to content
This repository has been archived by the owner on Jul 27, 2018. It is now read-only.

praekeltfoundation/diamondash

Repository files navigation

diamondash

Dashboard for how we use Graphite.

How to install

python setup.py install

How to configure

diamondash.yml is used to configure the web server and global dashboard defaults. Each file in dashboards/ contains a configuration for a particular dashboard. See etc/ for an example of how diamondash can be configured.

How to run

Diamondash is run as a twisted plugin:

twistd diamondash -c <CONFIG_DIR> -p <PORT>

For usage with supervisord, an example supervisord config file can be found in etc/.

Testing and Development

To run the server-side tests:

trial diamondash

For development and testing of the client-side code, you will need node.js. With node.js on your system, install the client-side dev dependencies with:

npm install

To run (client and server)-side tests:

./utils/run_tests.sh

To run client-side tests:

grunt test

For client-side development, a build step is required. To watch and build on changes:

grunt watch

Alternatively, building can be done manually with:

grunt build

Attributions

Thank you to GLYPHICONS for allowing use of GYPHICONS Halflings in Bootstrap, which diamondash uses :)