46a7f1f308
Displays a vector-based gauge on an HTML <canvas> element. Canvas elements don't accept relative widths and heights, so each time the view is resized, we have to recalculate the absolute size in pixels and update the canvas' properties. When the gauge's upper limit isn't defined by the user, it is updated to the biggest value encountered. To make this behaviour understandable, I made the decision to always display this maximum value alongside the current one. gauges.js has bunch of options (colors, animation speed, etc) which I left to the default values. This can be easily polished up later on if we feel the need to. |
||
|---|---|---|
| bin | ||
| example | ||
| lib/riemann | ||
| sh | ||
| test | ||
| .gitignore | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Rakefile.rb | ||
| README.markdown | ||
| riemann-dash.gemspec | ||
Riemann-Dash
A javascript, websockets-powered dashboard for Riemann.
Get started
$ gem install riemann-dash
$ riemann-dash
Then open http://localhost:4567 in a browser. Riemann-dash will connect to the local host (relative to your browser) by default, and show you a small manual. Change the IP address in the top right field to point to your Riemann server's websocket port.
Configuring
Riemann-dash takes an optional config file, which you can specify as the first command-line argument. If none is given, it looks for a file in the local directory: config.rb. That file can override any configuration options on the Dash class, and hence, all Sinatra configuration. You'll find a few usage examples in "example/config.rb".
set :port, 6000 # HTTP server on port 6000
set :bind, "1.2.3.4" # Bind to a different interface
config[:ws_config] = 'custom/config.json' # Specify custom workspace config
Putting in production
If you expect more than a couple of simultaneous users, you should consider running Riemann-dash in a proper application server. The easiest way is to install thin or puma. Riemann-dash will automatically use one of them if they are present. You'll need the C/C++ compiler, as well as the ruby and openssl libraries and headers installed.
$ gem install riemann-dash thin
$ riemann-dash
Development
$ git clone git://github.com/aphyr/riemann-dash.git
$ cd riemann-dash
$ bundle
Testing
# run tests
$ sh/test
Releasing
$ rake build
$ rake release
REPL
$ sh/c
> irb :001 > Riemann::Dash::VERSION
> => "0.2.2"