batsd-dash 0.2.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,94 @@
+batsd-dash
+==========
+
+Configurable dashboard for [batsd-server](https://github.com/noahhl/batsd).
+
+## Setup
+
+### Install
+
+To install batsd-dash, simply install the gem
+
+    gem install batsd-dash
+
+### Configuration
+
+Here is a sample rackup file (`config.ru`):
+    
+    require 'batsd-dash'
+
+    # set batsd server setting BatsdDash::ConnectionPool.settings = { host:'localhost', port: 8127, pool_size: 4 }
+
+    # run the app run BatsdDash::App
+
+Rack is very powerful. You can password protect your batsd-dash instance by
+using `Rack::Auth::Basic` or `Rack::Auth::Digest::MD5`.
+
+## Usage
+
+### Data API
+
+The application provides a simple JSON-based API for accessing data from the
+batds data server. There are 3 main routes provide, one for each datatype. These
+routes are `/counters`, `/timers` and `/gauges`. For example, the following
+request would access data for counter based metric:
+
+    /counters?metric=a.b
+
+It's possible to access data for more than one metric within a single request.
+For example, the following request route will return data for both the `a.b`
+metric and the `c.d` metric:
+
+    /counters?metrics[]=a.b&metrics[]=c.d
+
+The data API also accepts a `start` and `stop` unix timestamp parameter for
+accessing different ranges of data.
+
+Note that, the data API will only respond with JSON if the `Accept` header to
+set to `application/json`!
+
+### Viewing Graphs
+
+Graphs are rendered using Flot, a JavaScript library which uses the canvas
+element to create graphs. Since rendering is all done on the client, we make use
+of hash based navigation in order to reduce the amount of requests and while
+maintaining 'linkability'.
+
+For example, to view a graph for the `a.b` metric, you would make the following
+request from your browser:
+
+    /counters#metrics=a.b
+
+The graph view will provide you with a date time picker to make selecting
+different start and stop time ranges easier. Graphs are updated when you press
+the 'View' button.
+
+Much like the data API, it's possible to view more than one metric at the same
+time. To do this, visit the following route from your browser:
+
+    /counters#metrics=a.b,c.d
+
+_TODO_ when no data or only a single point is available, the graph is a little
+strange looking. This is something we will improve upon. Additionally, we also
+plan to add some sort of tree-based widget for selecting different metrics to
+view. 
+
+Feel free to submit pull requests with these features!
+
+### Zerofill
+
+_TODO_ add details about zerofill. 
+
+_TODO_ Setup client to accept pass along no-zerofill options.
+
+## Development
+
+### Asset Management
+
+We use Sass for CSS within this project. If you make any changes to the Sass
+files, ensure you recompile the CSS. This is done by running:
+    
+    compass compile --force --output-style compact --environment production --sass-dir lib/batsd-dash/sass --css-dir lib/public/css
+
+Additionally, it is highly recommended you use thin for development since this
+app uses EventMachine.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = ENV['TEST'] || Dir['test/test_*.rb']
+  t.verbose = true
+  #t.warning = true
+end
+

data/batsd-dash.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'batsd-dash/version'
+
+Gem::Specification.new do |s|
+  s.name        = "batsd-dash"
+  s.version     = BatsdDash::VERSION
+
+  s.authors     = ["mikeycgto", "btoconnor"]
+  s.email       = ["mikeycgto@gmail.com", "gatzby3jr@gmail.com"]
+
+  s.homepage    = "https://github.com/mikeycgto/batsd-dash"
+
+  s.summary     = %q{batsd-dash}
+  s.description = %q{batsd-dash - graphs and stuff from batds. yay.}
+
+  s.rubyforge_project = "batsd-dash"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency "sinatra"
+  s.add_dependency "sinatra-contrib"
+  s.add_dependency "sinatra-synchrony", "~> 0.3.2"
+
+  s.add_dependency "haml"
+  s.add_dependency "yajl-ruby"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "turn"
+
+  s.add_development_dependency "thin"
+end

data/lib/batsd-dash.rb

@@ -0,0 +1,82 @@
+require 'yajl'
+require 'sinatra/base'
+require 'sinatra/synchrony'
+#require 'sinatra/reloader' if ENV['RACK_ENV'] == 'development'
+
+%w[connection_pool graph params version].each { |file| require "batsd-dash/#{file}" }
+
+module BatsdDash
+  class App < Sinatra::Base
+    #configure(:development) { register Sinatra::Reloader }
+
+    configure do
+      register Sinatra::Synchrony
+      helpers ParamsHelper, GraphHelper, ConnectionHelpers
+
+      set :haml, :format => :html5
+
+      EM::Synchrony.next_tick { ConnectionPool::initialize_connection_pool }
+    end
+
+    helpers do
+      def render_error(msg)
+        render_json 400, error: msg
+      end
+
+      def render_json(code = 200, json)
+        halt code, String === json ? json : Yajl::Encoder.encode(json)
+      end
+    end
+
+    get "/" do
+      haml :root
+    end
+
+    get "/version", :provides => :json do
+      render_json version: BatsdDash::VERSION
+    end
+
+    get "/available", :provides => :json do
+      connection_pool.async_available_list.callback do |json|
+        render_json json
+      end
+    end
+
+    %w[ counters timers gauges ].each do |datatype|
+      # this route renders the template (with codes for the graph)
+      get "/#{datatype}", :provides => :html do
+        haml :view
+      end
+
+      # actual data API route
+      get "/#{datatype}", :provides => :json do
+        metrics = parse_metrics
+        range = parse_time_range
+
+        return render_error('Invalid time range') unless range
+        return render_error('Invalid metrics') if metrics.empty?
+
+        results = { range: range.dup.map! { |n| n * 1000 }, metrics: [] }
+        collect_opts = { zero_fill: !params[:no_zero_fill], range: results[:range] }
+
+        metrics.each do |metric|
+          statistic = "#{datatype}:#{metric}"
+          deferrable = connection_pool.async_values(statistic, range)
+
+          deferrable.errback { |e| return render_error(e.message) }
+          deferrable.callback do |json|
+            values = json[statistic]
+
+            # merge in interval if its not already; interval is always same
+            collect_opts.merge!(interval: json['interval'] || 0) unless collect_opts.has_key?(:interval)
+            # process values for graphing and add to results
+            results[:metrics] << { label: metric, data: collect_for_graph(values, collect_opts) }
+          end
+        end
+
+        cache_control :no_cache, :no_store
+        render_json results
+      end
+    end
+  end
+end

data/lib/batsd-dash/connection_pool.rb

@@ -0,0 +1,87 @@
+module BatsdDash
+  module ConnectionHelpers
+    def connection_pool
+      ConnectionPool.pool or render_error('Connect pool failed to connect to Batsd')
+    end
+  end
+
+  class ConnectionPool
+    class << self
+      attr_accessor :settings
+      attr_reader :pool
+
+      def initialize_connection_pool
+        # default settings (which are defaults from batsd itself)
+        @settings ||= { host: 'localhost', port: 8127, pool_size: 4 }
+
+        if @reconnect_timer
+          @reconnect_timer.cancel
+          @reconnect_timer = nil
+        end
+
+        begin
+          @pool = EventMachine::Synchrony::ConnectionPool.new(size: settings[:pool_size]) do
+            Client.new(settings[:host], settings[:port])
+          end
+
+        rescue Exception => e
+          warn "Connection Pool Error: #{e.message}"
+
+        end
+      end
+
+      def close_connection_pool
+        @pool.close if @pool
+        @pool = nil
+      end
+
+      def start_reconnect_timer
+        unless @reconnect_timer
+          # try to reconnect every 30 seconds
+          @reconnect_timer = EventMachine::Synchrony.add_timer(30) { initialize_connection_pool }
+        end
+      end
+    end
+
+    class Client < EventMachine::Synchrony::TCPSocket
+      def write_and_read_json(request)
+        EventMachine::DefaultDeferrable.new.tap do |df|
+          response = String.new
+          parser = Yajl::Parser.new
+          parser.on_parse_complete = Proc.new { |json| df.succeed(json) }
+
+          begin
+            write request
+
+            # keep reading till we hit new line
+            while response[-1] != "\n"
+              response << read(1)
+            end
+
+            parser.parse response
+
+          rescue Exception => e
+            # TODO handle broken pipe
+            #unbind if Errno::EPIPE === e
+
+            df.fail(e)
+          end
+        end
+      end
+
+      def async_available_list
+        write_and_read_json "available"
+      end
+
+      def async_values(statistic, range)
+        write_and_read_json "values #{statistic} #{range[0]} #{range[1]}"
+      end
+
+      def unbind(reason = nil)
+        super(reason)
+
+        ConnectionPool::start_reconnect_timer
+      end
+    end
+  end
+end

data/lib/batsd-dash/graph.rb

@@ -0,0 +1,46 @@
+# helpers for parsing and validating input
+module BatsdDash
+  module GraphHelper
+    ##
+    # This method works directly against values
+    def collect_for_graph(values, opts = {})
+      values.tap do |pts|
+        # remap the values
+        pts.map! { |pt| [pt['timestamp'].to_i * 1000, pt['value'].to_f] }
+
+        # apply zerofill
+        zero_fill!(pts, opts[:range], opts[:interval]) unless pts.empty? || !opts[:zero_fill]
+      end
+    end
+
+    ##
+    # The data better be normalized to the interval otherwise
+    # this method may get pissed
+    def zero_fill!(values, range, step)
+      return values if step.zero?
+
+      # convert to milisec
+      step *= 1000
+
+      values.tap do |data|
+        # start from the first timestamp
+        time = data.first.first + step
+        index = 0
+
+        while obj = data[index += 1]
+          current = obj.first
+
+          next if current <= time
+          if current == time
+            time += step
+            next
+          end
+
+          data.insert(index, [time, 0])
+
+          time += step
+        end
+      end
+    end
+  end
+end

data/lib/batsd-dash/params.rb

@@ -0,0 +1,30 @@
+# helpers for processing params and validating input
+module BatsdDash
+  module ParamsHelper
+    def parse_metrics
+      metrics = params[:metrics]
+      metrics = [metrics] unless Array === metrics
+
+      metrics.tap { |list| list.reject! { |m| m.nil? || m.empty? } }
+    end
+
+    def parse_time_range
+      start, stop = params[:start], params[:stop]
+
+      if start.nil? && stop.nil?
+        now = Time.now.to_i
+
+        # 1 hr range
+        # TODO make this setting?
+        [ now - 3600 + 1, now ]
+
+      else
+        [start.to_i, stop.to_i].tap do |range|
+          if range[0] <= 0 || range[1] <= 0 || range[0] >= range[1]
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/batsd-dash/sass/public.scss

@@ -0,0 +1,56 @@
+@import "compass/utilities/general/clearfix";
+@import "compass/css3";
+@import "compass/reset";
+
+html, body { height:100%; min-height:100%; background-color:#222; }
+h1, h2 { color:#0F0; font-family:"Courier New",Courier,monospace; }
+a { text-decoration:none; color:inherit; }
+
+.wrap { width:1000px; margin:0 auto; }
+
+#header {
+    height:60px; border:1px solid #0F0; border-width:0 0 1px 0; margin:0 0 20px;
+
+    background-color: #000000;
+    @include filter-gradient(#000000, #222, vertical);
+    @include background-image(linear-gradient(top, #000000 0%,#222 100%));
+
+    @include pie-clearfix;
+
+    h1 { float:left; font-size:28px; padding:15px 0 0; }
+    ul {
+        float:right; width:300px; margin:15px 0;
+
+        li {
+            float:left; margin:0 20px;
+            a { cursor:pointer; }
+        }
+    }
+}
+
+
+#content {
+    color:#FFF; width:1000px; margin:0 auto; font-size:18px;
+
+    h1 { font-size:26px; margin:30px 0; }
+    h2 { font-size:24px; margin:20px 0; }
+
+    p {
+        em { font-style:italic; margin:0 -4px 0 0; }
+    }
+
+    .graph {
+        width:900px; height:400px; margin:0 auto;
+
+        h2 { text-align:center; margin:180px; }
+    }
+
+    .inputs {
+        width:900px; margin:0 auto 30px; text-align:center;
+
+        label { font-weight:bold; }
+        input { width:200px; }
+    }
+}
+
+