rack-statsd_batch 0.0.1

data/README.md

@@ -0,0 +1,29 @@
+# Rack::StatsdBatch
+
+Throw your metrics data into your request env, and on egress it will get pushed
+to statsd in as few requests as possible.
+
+# Setup
+
+Add to your gemfile
+
+    gem 'rack-statsd_batch', '~> 0.0.1', require: 'rack/statsd_batch'
+
+Add to your middleware in config/application.rb
+
+    config.middleware.use Rack::StatsdBatch, 'statsd-server.myhost.com', 1234
+
+# Use
+
+The stats collector is included in your request environment. Access it from your
+controller:
+
+    metrics = request.env['metrics']
+
+There are five message types that map to the statsd backend
+
+    metrics.gauge_diff 'registered-users', +1
+    metrics.gauge 'total_things', 2037
+    metrics.timing 'render_time_ms', 237
+    metrics.count 'things_done', 1
+    metrics.sets 'user_ids', 27

data/lib/rack/statsd_batch.rb

@@ -0,0 +1,89 @@
+require 'socket'
+
+module Rack
+  class StatsdBatch
+    def initialize rack_app, hostname, port, mtu=1432
+      @app = rack_app
+      @hostname = hostname
+      @port = port
+      @mtu = mtu
+    end
+
+    def call env
+      env['metrics'] = Rack::StatsdBatch::Recorder.new
+      status, headers, response = @app.call(env)
+      env['metrics'].publish(@hostname, @port, @mtu)
+      [status, headers, response]
+    end
+
+    class Recorder
+      attr_reader :data
+
+      def initialize
+        @data = []
+      end
+
+      def count key, diff
+        @data << "#{key}:#{diff}|c"
+      end
+
+      def timing key, ms
+        @data << "#{key}:#{ms}|ms"
+      end
+
+      def gauge key, value
+        @data << "#{key}:#{value}|g"
+      end
+
+      def gauge_diff key, diff
+        value = "#{diff}"
+        value = "+#{value}" if diff > 0
+        @data << "#{key}:#{value}|g"
+      end
+
+      def sets key, set_entry
+        @data << "#{key}:#{set_entry}|s"
+      end
+
+      def publish host, port, mtu
+        return if @data.empty?
+        c = connection(host, port)
+        build_packets(mtu).each {|p| c.send(p) }
+      end
+
+      private
+
+      def connection host, port
+        Rack::StatsdBatch::Connection.new(UDPSocket.new, host, port)
+      end
+
+      def build_packets mtu
+        rv = []
+        packet = ''
+        while !data.empty?
+          message = data.shift
+          newline_length = packet.empty? ? 0 : 1
+          if packet.length + message.length + newline_length > mtu
+            rv << packet
+            packet = ''
+          end
+          message = "\n#{message}" unless packet.empty?
+          packet << message
+        end
+        (rv << packet) unless packet.empty?
+        rv
+      end
+    end
+
+    class Connection
+      def initialize socket, *extra_params
+        @socket = socket
+        @extras = extra_params
+      end
+
+      def send data
+        @socket.send(data, flags=0, *@extras)
+      end
+    end
+  end
+end

data/rack-statsd_batch.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2
+  s.required_rubygems_version = Gem::Requirement.new(">= 0")
+
+  s.name              = 'rack-statsd_batch'
+  s.version           = '0.0.1'
+  s.date              = '2013-12-13'
+
+  s.summary     = 'Send metrics data to statsd after your request'
+  s.description = 'Exposes a metrics collector to the request environment and flushes the data to statsd when the request is finished. Batches the data to send as few packets as possible.'
+
+  s.authors  = ['xtoddx (Todd Willey)']
+  s.email    = 'xtoddx@gmail.com'
+  s.homepage = 'http://github.com/CirrusMio/rack-statsd_batch'
+  s.license  = 'MIT'
+
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency('minitest')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- tests/*`.split("\n")
+end

data/test/application_interface_test.rb

@@ -0,0 +1,46 @@
+gem 'minitest'
+require 'minitest/autorun'
+
+require_relative '../lib/rack/statsd_batch'
+
+class ApplicationInterfaceTest < MiniTest::Test
+  def setup
+    @recorder = Rack::StatsdBatch::Recorder.new
+  end
+
+  def test_count
+    @recorder.count('mykey', 1)
+    assert_equal 1, @recorder.data.length
+    assert_equal 'mykey:1|c', @recorder.data.first
+  end
+
+  def test_timing
+    @recorder.timing('mykey', 1)
+    assert_equal 1, @recorder.data.length
+    assert_equal 'mykey:1|ms', @recorder.data.first
+  end
+
+  def test_gauge_diff_negative
+    @recorder.gauge_diff('mykey', 1)
+    assert_equal 1, @recorder.data.length
+    assert_equal 'mykey:+1|g', @recorder.data.first
+  end
+
+  def test_gauge_diff_negative
+    @recorder.gauge_diff('mykey', -1)
+    assert_equal 1, @recorder.data.length
+    assert_equal 'mykey:-1|g', @recorder.data.first
+  end
+
+  def test_gauge_set
+    @recorder.gauge('mykey', 10)
+    assert_equal 1, @recorder.data.length
+    assert_equal 'mykey:10|g', @recorder.data.first
+  end
+
+  def test_set_multiple_things
+    @recorder.gauge('mykey', 1)
+    @recorder.gauge_diff('myotherkey', 10)
+    assert_equal 2, @recorder.data.length
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,43 @@
+gem 'minitest'
+require 'minitest/autorun'
+
+require_relative '../lib/rack/statsd_batch'
+
+$statsd_connection = nil
+class TestConnection
+  attr_reader :packets
+
+  def initialize socket, host, port
+    $statsd_connection = self
+  end
+
+  def send packet
+    (@packets ||= []) << packet
+  end
+end
+
+class ConnectionTest < MiniTest::Test
+  def setup
+    @old_const = Rack::StatsdBatch::Connection
+    Rack::StatsdBatch.const_set :Connection, TestConnection
+    @recorder = Rack::StatsdBatch::Recorder.new
+    @recorder.gauge 'mygauge', 1
+    @recorder.gauge_diff 'myothergauge', 3
+  end
+
+  def teardown
+    Rack::StatsdBatch.const_set :Connection, @old_const
+  end
+
+  def test_sends_packet
+    @recorder.publish('hostname', port=1234, mtu=1024)
+    assert_equal 1, $statsd_connection.packets.length
+    assert_equal "mygauge:1|g\nmyothergauge:+3|g",
+                 $statsd_connection.packets.first
+  end
+
+  def test_splits_packets
+    @recorder.publish('hostname', port=1234, mtu=@recorder.data.first.length)
+    assert_equal 2, $statsd_connection.packets.length
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,29 @@
+gem 'minitest'
+require 'minitest/autorun'
+
+require_relative '../lib/rack/statsd_batch'
+
+class MiddlewareTestApp
+  attr_accessor :callback
+
+  def call env
+    if @callback
+      @callback.call(env)
+    end
+    return [{}, 200, '']
+  end
+end
+
+class MiddlewareTest < MiniTest::Test
+  def setup
+    @tester = MiddlewareTestApp.new
+    @app = Rack::StatsdBatch.new(@tester, 'localhost', 1234)
+  end
+
+  def test_env_contains_recorder
+    passed = nil
+    @tester.callback = ->(env){ passed = env.include?('metrics') }
+    @app.call({})
+    assert passed
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rack-statsd_batch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- xtoddx (Todd Willey)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exposes a metrics collector to the request environment and flushes the
+  data to statsd when the request is finished. Batches the data to send as few packets
+  as possible.
+email: xtoddx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rack/statsd_batch.rb
+- rack-statsd_batch.gemspec
+- test/application_interface_test.rb
+- test/connection_test.rb
+- test/middleware_test.rb
+homepage: http://github.com/CirrusMio/rack-statsd_batch
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 2
+summary: Send metrics data to statsd after your request
+test_files: []
+has_rdoc: