No description
Find a file
2016-06-23 17:41:53 +02:00
bin rename Riemann::Dash -> Riemann::Dash::App + move sinatra app to app.rb 2013-03-11 13:10:19 +02:00
example use standard riemann-dash port 2016-06-23 17:19:40 +02:00
img added screenshot 2016-06-23 17:36:31 +02:00
lib/riemann minor css fix 2015-03-24 15:51:59 +01:00
sh readme for tests 2013-03-11 13:32:53 +02:00
test Extra happy tests for merge_workspace 2014-12-04 21:05:08 +11:00
.gitignore moving config back to previous location for backward compatibility 2013-03-15 03:24:18 +00:00
Gemfile moving config back to previous location for backward compatibility 2013-03-15 03:24:18 +00:00
Gemfile.lock Add support for multiple backends to store config (S3 and File for now) 2014-03-14 15:31:29 +01:00
LICENSE Initial commit: version 0.0.3 2012-02-18 15:22:24 -08:00
Rakefile.rb rake test task 2013-03-11 13:29:21 +02:00
randomize-ids.sh added screenshot 2016-06-23 17:36:31 +02:00
README.markdown added screenshot to README 2016-06-23 17:41:53 +02:00
riemann-dash.gemspec use webrick by default, document thin/puma installation 2014-06-05 01:10:55 +02:00

Riemann-Dash

screenshot

Remark: the riemann config is the file riemann.config. It contains alert rules.

Riemann-Dash is 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

Riemann-dash can also run in a web server supporting the Rack interface. An example rackup app is found in "example/config.ru".

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"