riemann-dash 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 333646d7d876e408d47965ae5a0f27234e6b8821
-  data.tar.gz: 286df1ba3416046249397560a6572cff9b87974d
+  metadata.gz: 1dcb96d79006cd63317f46f52072596a7e8d8191
+  data.tar.gz: 57dbb5238edab2d60bdb09613be4ccb58cbd977f
 SHA512:
-  metadata.gz: 71467857647cd99ea04b87956f644897b61405e29e0b950a9dc67501e31128cc249113a27842544c61b385cd32f710da8b8ecf59f77815e91de775fd623a8af6
-  data.tar.gz: c903a2a28580057a35bb83c7dc5e2126012704b5995c7a19b2a10db0ba521634bb5198e6ce754161851668d26656cb84c178f7b4ec3f07cd01b77310f0c6135c
+  metadata.gz: d6cf10ac7232174d526ae3666265e374246e89f7bb8a8e2a0a39b1199ef7c9e4f0db1f2b02ec6199c7e283a19902cda08639d81909f62cba726f07c53c90622e
+  data.tar.gz: 0aab886e0f0531fe1e5c075b2a54664b8e00da4d3f78028b21276c8b903c9c0cc34906fed09988d3180779e00866066917609946a9e43c274db388c5224edebe

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    riemann-dash (0.2.5)
+    riemann-dash (0.2.8)
       erubis (>= 2.7.0)
+      fog
       multi_json (= 1.3.6)
       riemann-client (>= 0.0.7)
       sass (>= 3.1.14)
@@ -12,34 +13,55 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    beefcake (0.3.7)
+    beefcake (0.5.0)
+    builder (3.2.2)
     coderay (1.0.9)
     daemons (1.1.9)
     erubis (2.7.0)
     eventmachine (1.0.3)
+    excon (0.31.0)
+    fog (1.19.0)
+      builder
+      excon (~> 0.31.0)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5)
+      ruby-hmac
+    formatador (0.2.4)
     method_source (0.8.1)
+    mime-types (2.0)
+    mini_portile (0.5.2)
     mtrc (0.0.4)
     multi_json (1.3.6)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
     pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
     rack (1.5.2)
-    rack-protection (1.5.0)
+    rack-protection (1.5.2)
       rack
     riemann-client (0.2.2)
       beefcake (>= 0.3.5)
       mtrc (>= 0.0.4)
       trollop (>= 1.16.2)
-    sass (3.2.7)
-    sinatra (1.3.6)
+    ruby-hmac (0.4.0)
+    sass (3.3.2)
+    sinatra (1.4.4)
       rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
     slop (3.4.3)
-    thin (1.5.1)
+    thin (1.6.2)
       daemons (>= 1.0.9)
-      eventmachine (>= 0.12.6)
+      eventmachine (>= 1.0.0)
       rack (>= 1.0.0)
     tilt (1.4.1)
     trollop (2.0)

data/README.markdown

@@ -11,7 +11,10 @@ Get started
     $ 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.
+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
 ===========
@@ -19,7 +22,8 @@ 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.
+Dash class, and hence, all Sinatra configuration. You'll find a few usage
+examples in "example/config.rb".
 
 ``` ruby
 set :port, 6000      # HTTP server on port 6000
@@ -27,7 +31,19 @@ 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.
+
+``` bash
+    $ gem install riemann-dash thin
+    $ riemann-dash
+```
 
 Development
 ===========

data/example/config.rb

@@ -15,3 +15,8 @@ config.store[:ws_config] = "#{riemann_base}/config/config.json"
 
 # Serve static files from this directory
 config.store[:public] = "#{riemann_src}/public"
+
+# Save workspace configuration to Amazon S3 (you'll need to have the "fog"
+# gem installed)
+# config.store[:ws_config] = 's3://my-bucket/config.json'
+# config.store[:s3_config] = {:aws_access_key_id => "123ABC", :aws_secret_access_key => "789XYZ"}

data/lib/riemann/dash.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'sinatra/base'
 require 'riemann/dash/version'
+require 'riemann/dash/browser_config'
 require 'riemann/dash/config'
 require 'riemann/dash/app'

data/lib/riemann/dash/app.rb

@@ -26,6 +26,7 @@ module Riemann
         config.load_controllers
         config.setup_views
         config.setup_public_dir
+        config.setup_storage_backend
       end
     end
   end

data/lib/riemann/dash/browser_config.rb

@@ -0,0 +1,72 @@
+module Riemann::Dash::BrowserConfig
+  require 'multi_json'
+  require 'fileutils'
+  require 'pp'
+
+  def self.backend
+    @backend
+  end
+
+  def self.backend=(backend)
+    @backend = backend
+  end
+
+  # TODO: this is gonna take significant restructuring of the dashboard itself,
+  # but we should move to http://arxiv.org/abs/1201.1784 or equivalent CRDTs.
+
+  # Given a function to extract a key from an element, and a list of elements,
+  # returns a map of keys to elements. Keys are assumed unique.
+  def self.index_by(keyfn, list)
+    list.reduce({}) do |index, element|
+      index[keyfn.call(element)] = element
+      index
+    end
+  end
+
+  # Merges two lists, given a key function which determines equivalent
+  # elements, and a merge function to combine equivalent elements.
+  def self.merge_lists(keyfn, mergefn, as, bs)
+    asi = index_by keyfn, as
+    bsi = index_by keyfn, bs
+    ids = (as + bs).map(&keyfn).uniq.map do |key|
+      mergefn.call asi[key], bsi[key]
+    end
+  end
+
+  # Merge two workspaces together
+  def self.merge_workspace(a, b)
+    # TODO: workspace versions
+    return a unless b
+    return b unless a
+    if (a['view']['version'] || 0) < (b['view']['version'] || 0)
+      b
+    else
+      a
+    end
+  end
+
+  # Merge a list of workspaces together
+  def self.merge_workspaces(as, bs)
+    return as unless bs
+    return bs unless as
+    merge_lists(lambda { |x| x['name'] },
+                method(:merge_workspace),
+                as,
+                bs)
+  end
+
+  # Merge two configs together
+  def self.merge_configs(a, b)
+    a.merge 'server'      => (a['server']      or b['server']),
+            'server_type' => (a['server_type'] or b['server_type']),
+            'workspaces'  => merge_workspaces(a['workspaces'], b['workspaces'])
+  end
+
+  def self.read
+    backend.read
+  end
+
+  def self.update(update)
+    backend.update(update)
+  end
+end

data/lib/riemann/dash/browser_config/file.rb

@@ -0,0 +1,39 @@
+class Riemann::Dash::BrowserConfig::File
+  require 'multi_json'
+  require 'fileutils'
+
+  def initialize(path)
+    @path = path
+  end
+
+  def read
+    if ::File.exists? @path
+      ::File.open(@path, 'r') do |f|
+        f.flock ::File::LOCK_SH
+        f.read
+      end
+    else
+      MultiJson.encode({})
+    end
+  end
+
+  def update(update)
+    update = MultiJson.decode update
+
+    # Read old config
+    old = MultiJson.decode read
+
+    new = Riemann::Dash::BrowserConfig.merge_configs update, old
+
+    # Save new config
+    FileUtils.mkdir_p ::File.dirname(@path)
+    begin
+      ::File.open(@path, ::File::RDWR|::File::CREAT, 0644) do |f|
+        f.flock ::File::LOCK_EX
+        f.write(MultiJson.encode(new, :pretty => true))
+        f.flush
+        f.truncate f.pos
+      end
+    end
+  end
+end

data/lib/riemann/dash/browser_config/s3.rb

@@ -0,0 +1,30 @@
+class Riemann::Dash::BrowserConfig::S3
+  require 'multi_json'
+  require 'fog'
+
+  def initialize(bucket, path, config = {})
+    @bucket = bucket
+    @path   = path
+    @config = config
+
+    @storage = Fog::Storage::AWS.new(config)
+  end
+
+  def read
+    begin
+      @storage.get_object(@bucket, @path).body
+    rescue Excon::Errors::NotFound
+      MultiJson.encode({})
+    end
+  end
+
+  def update(update)
+    update = MultiJson.decode update
+
+    # Read old config
+    old = MultiJson.decode read
+
+    new = Riemann::Dash::BrowserConfig.merge_configs update, old
+    @storage.put_object @bucket, @path, MultiJson.encode(new, :pretty => true)
+  end
+end

data/lib/riemann/dash/config.rb

@@ -1,4 +1,6 @@
 class Riemann::Dash::Config
+  require 'uri'
+
   attr_accessor :config_path
   attr_accessor :store
 
@@ -62,6 +64,25 @@ class Riemann::Dash::Config
     Riemann::Dash::App.use Riemann::Dash::Static, :root => store[:public]
   end
 
+  def setup_storage_backend
+    uri = URI.parse(ws_config_file)
+    backend = case uri.scheme
+            when "s3"
+              begin
+                require 'riemann/dash/browser_config/s3'
+                Riemann::Dash::BrowserConfig::S3.new(uri.host, uri.path.sub(/^\//, ''), store[:s3_config])
+              rescue LoadError
+                raise Exception.new 'Fog library required to save to S3. Run: "gem install fog"'
+              end
+            when nil, "file"
+              require 'riemann/dash/browser_config/file'
+              Riemann::Dash::BrowserConfig::File.new(uri.path)
+            else
+              raise Exception.new "Unknown backend for #{ws_config_file}"
+            end
+    Riemann::Dash::BrowserConfig.backend = backend
+  end
+
   # Load controllers.
   def load_controllers_from(dir)
     sorted_controller_list(dir).each do |r|
@@ -113,45 +134,4 @@ class Riemann::Dash::Config
       end
     end
   end
-
-
-  require 'multi_json'
-  require 'fileutils'
-
-
-  def read_ws_config
-    if File.exists? ws_config_file
-      File.read(ws_config_file)
-    else
-      MultiJson.encode({})
-    end
-  end
-
-  def update_ws_config(update)
-    update = MultiJson.decode(update)
-
-    # Read old config
-    if File.exists? ws_config_file
-      old = MultiJson.decode File.read(ws_config_file)
-    else
-      old = {}
-    end
-
-    new_config = {}
-
-    # Server
-    new_config['server'] = update['server'] or old['server']
-
-    # Server Type
-    new_config['server_type'] = update['server_type'] or old['server_type']
-
-    #p update['workspaces']
-    new_config['workspaces'] = update['workspaces'] or old['workspaces']
-
-    # Save new config
-    FileUtils.mkdir_p File.dirname(ws_config_file)
-    File.open(ws_config_file, 'w') do |f|
-      f.write(MultiJson.encode(new_config, :pretty => true))
-    end
-  end
 end

data/lib/riemann/dash/controller/index.rb

@@ -5,16 +5,16 @@ class Riemann::Dash::App
 
   get '/config', :provides => 'json' do
     content_type "application/json"
-    config.read_ws_config
+    Riemann::Dash::BrowserConfig.read
   end
 
   post '/config' do
     # Read update
     request.body.rewind
-    config.update_ws_config(request.body.read)
+    Riemann::Dash::BrowserConfig.update request.body.read
 
     # Return current config
     content_type "application/json"
-    config.read_ws_config
+    Riemann::Dash::BrowserConfig.read
   end
-end
+end

data/lib/riemann/dash/public/dash.js

@@ -193,17 +193,20 @@ dash = (function() {
       '<li><b>e</b>: edit the view</li>' +
       '<li><b>?</b>: display this help box</li>' +
       '<li><b>s</b>: save the dashboard</li>' +
+      '<li><b>r</b>: reload the dashboard from last saved config</li>' +
       '<li><b>+</b>: increase the size of the view</li>' +
       '<li><b>-</b>: decrease the size of the view</li>' +
       '<li><b>v</b>: split the view vertically</li>' +
       '<li><b>h</b>: split the view horizontally</li>' +
       '<li><b>&#8592;</b>: left arrow move the view to the left</li>' +
       '<li><b>&#8594;</b>: right arrow move the view to the right</li>' +
-      '<li><b>&#8593;</b>: up arrow move the view up>' +
+      '<li><b>&#8593;</b>: up arrow move the view up</li>' +
       '<li><b>&#8595;</b>: down arrow move the view down</li>' +
+      '<li><b>pageup</b>: select the parent of the current view</li>' +
       '<li><b>d</b>: delete a view</li>' +
       '<li><b>delete</b>: delete a view</li>' +
       '<li><b>alt-1, alt-2, etc</b>: switch to a different workplace</li>' +
+      '<li><b>p</b>: pause/unpause the event stream(s)</li>' +
       '</ul></div>'
     );
 

data/lib/riemann/dash/public/eventPane.js

@@ -0,0 +1,63 @@
+// Pane at the bottom of the dashboard for displaying events in context.
+
+var eventPane = (function() {
+  var el = $('#event-pane');
+  var fixedFields = ['host', 'service', 'time', 'state', 'metric', 'ttl', 'description', 'tags'];
+  var fixedTemplate =
+    _.template(
+      '<div class="host">{{-host}}</div>' +
+      '<div class="service">{{-service}}</div>' +
+      '<div class="state {{-state}}">{{-state}}</div>' +
+      '<div class="metric">{{-metric}}</div>' +
+      '<time class="absolute">{{-time}}</time>' +
+      '<div class="ttl">{{-ttl}}</div>' +
+      '<div class="tags">{{-tags}}</div>' +
+      '<div class="description">{{-description}}</description>');
+
+  var rowTemplate =
+        _.template("<tr><td>{{-field}}</td><td>{{-value}}</td></tr>");
+
+  // Hide the pane
+  var hide = function() {
+    if (el.hasClass("active")) {
+      el.empty();
+      el.removeClass("active");
+    }
+  };
+
+  // Show an event in the pane
+  var show = function(event) {
+    hide();
+
+    if (! el.hasClass("active")) {
+      el.addClass("active");
+    }
+
+    el.append(
+        fixedTemplate(
+          _.defaults(
+            util.merge(event, {time: new Date(event.time)}),
+            {host: "nil",
+             service: "nil",
+             state: "nil",
+             metric: "nil",
+             ttl: "nil",
+            tags: "nil",
+            description: "nil"})));
+
+    var table = el.append('<table></table>');
+
+    // Remaining fields
+    _.each(event, function(value, field) {
+      if (! _.contains(fixedFields, field)) {
+        table.append(rowTemplate({field: field, value: value}));
+      }
+    });
+  };
+
+  // Hide on escape.
+  keys.bind(27, hide);
+
+  return {show: show,
+          hide: hide};
+})();