metriks-dogstatsd 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@metriks-dogstatsd

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    metriks-dogstatsd (0.0.1alpha1)
+      dogstatsd-ruby (= 1.1.0)
+      metriks (~> 0.9.9.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    atomic (1.0.1)
+    avl_tree (1.1.3)
+    dogstatsd-ruby (1.1.0)
+    hitimes (1.1.1)
+    metaclass (0.0.1)
+    metriks (0.9.9.2)
+      atomic (~> 1.0)
+      avl_tree (~> 1.1.2)
+      hitimes (~> 1.1)
+    mocha (0.12.7)
+      metaclass (~> 0.0.1)
+    rake (0.9.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  metriks-dogstatsd!
+  mocha (~> 0.12.3)
+  rake (~> 0.9.2)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/metriks-dogstatsd.rb

@@ -0,0 +1 @@
+require 'metriks/reporter/dogstatsd'

data/lib/metriks/reporter/dogstatsd.rb

@@ -0,0 +1,149 @@
+require 'statsd' # from dogstatsd-ruby
+
+module Metriks::Reporter
+  # Adapter class for dogstatsd-ruby and the metriks metric collection
+  # system.
+  class DogStatsd
+
+    attr_reader :client
+    
+    def initialize host, port, options={}
+
+      @client = Statsd.new(host, port)
+
+      @prefix = options[:prefix]
+
+      @registry = options[:registry] || Metriks::Registry.default
+      @interval = options[:interval] || 60 # Seconds
+      @timeout_seconds = options[:timeout_seconds] || 45 # Seconds
+      @on_error = options[:on_error] || proc{|exception| } # by default, do nothing and just reconnect to the backend
+      Statsd.logger = options[:logger]
+
+    end
+
+    # Get the socket reference to the backend server.
+    # This is broken out to simplify testing.
+    def socket
+      @client.instance_variable_get(:@socket)
+    end
+
+    # Set the socket reference to the backend server.
+    # This is broken out to simplify testing.
+    def socket= io
+      @client.instance_variable_set(:@socket, io)
+    end
+
+    # Start the backend thread. The backend thread handles connections to
+    # the dogstatsd daemon.
+    def start
+      @thread ||= Thread.new do
+        loop do
+          sleep @interval # don't peg the cpu or wakeup continuously
+          spawn_threaded_write_system
+        end
+      end
+    end
+
+    def spawn_threaded_write_system
+      Thread.new do
+        begin
+          Timeout::timeout(@timeout_seconds) do
+            write
+          end
+
+        # Yes, this is dumb, but I need to asynchronously pass the
+        # exception up the thread stack and reconnect to the server seamlessly
+        rescue Exception => ex
+          @on_error.call(ex)
+        end
+
+      end
+    end
+    
+    # Kill and release the backend thread.
+    def stop
+      @thread.kill if @thread
+      @thread = nil
+    end
+
+    # Restart the backend thread. This is implemented as a plain stop,
+    # followed by a plain start
+    def restart
+      stop
+      start
+    end
+
+    # Flush the metrics being aggregated by the registry to the
+    # statistics collection backend
+    def write
+      @registry.each do |name, metric|
+        case metric # handle all potential metric types
+          when Metriks::Meter
+            write_metric name, metric, :meter, [
+              # derived metrics
+              :count, :one_minute_rate, :five_minute_rate, :fifteen_minute_rate, :mean_rate
+            ]
+          when Metriks::Counter
+            write_metric name, metric, :counter, [
+              :count
+            ]
+          when Metriks::UtilizationTimer
+            write_metric name, metric, :utilization_timer, [
+              :count, :one_minute_rate, :five_minute_rate, :fifteen_minute_rate, :mean_rate, :min, :max, :mean, :stddev
+            ], [
+              # snapshot metrics
+              :median, :get_95th_percentile
+            ]
+          when Metriks::Timer
+            write_metric name, metric, :timer, [
+              :count, :one_minute_rate, :five_minute_rate, :fifteen_minute_rate, :mean_rate, :min, :max, :mean, :stddev
+            ], [
+              :median, :get_95th_percentile
+            ]
+          when Metriks::Histogram
+            write_metric name, metric, :histogram, [
+              :count, :min, :max, :mean, :stddev
+            ], [
+              :median, :get_95th_percentile
+            ]
+        end
+      end
+    end
+
+    def write_metric(base_name, metric, type, keys, snapshot_keys = [])
+      # squash all metrics base name whitespace to underscores
+      # the backend system doesn't do whitespace
+      base_name = base_name.to_s.gsub(/ +/, '_')
+
+      #prefix the base_name if we've got one set
+      base_name = "#{@prefix}.#{base_name}" if @prefix
+
+      keys.flatten.each do |key|
+        name = key.to_s.gsub(/^get_/, '')
+        value = metric.send(key)
+        if key == :count
+          case type
+            when :meter, :counter
+              @client.count(base_name, value)
+            when :timer, :utilization_timer, :histogram
+              @client.histogram("#{base_name}.#{name}", value)
+          end
+        else
+          @client.gauge("#{base_name}.#{name}", value)
+        end
+      end
+
+      unless snapshot_keys.empty?
+        snapshot = metric.snapshot
+        snapshot_keys.flatten.each do |key|
+          name = key.to_s.gsub(/^get_/, '')
+          value = snapshot.send(key)
+          @client.gauge("#{base_name}.#{name}", value)
+        end
+      end
+
+    end
+  end
+end
+
+require 'metriks/reporter/dogstatsd/version'

data/lib/metriks/reporter/dogstatsd/version.rb

@@ -0,0 +1,25 @@
+module Metriks
+  module Reporter
+    class DogStatsd
+
+      # Release version for metriks-dogstatsd. This versioning scheme adheres
+      # to the [semantic versioning specification](http://semver.org).
+      module Version
+        # The Major Version Number
+        MAJOR = '0'
+        # The Minor Version Number
+        MINOR = '1'
+        # The Patch Version Number
+        PATCH = '0'
+
+        # Converts the information stored in the Version module into a standards compliant
+        # version identification string
+        # @return [String] The standard version string
+        def self.to_standard_version_s
+          [ MAJOR, MINOR, PATCH ].join '.'
+        end
+      end
+
+    end
+  end
+end

data/metriks-dogstatsd.gemspec

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__),'lib','metriks','reporter','dogstatsd','version')
+
+Gem::Specification.new do |gem|
+  gem.name = 'metriks-dogstatsd'
+  gem.version = Metriks::Reporter::DogStatsd::Version.to_standard_version_s
+
+  gem.authors = ["Justin 'J' Lynn", "Sponsored by Mavenlink, Inc."]
+  gem.email = ["j@jaesharp.com"]
+
+  gem.summary = "A DogStatsD compatible reporter for the metriks metric reporting gem"
+  gem.description = gem.summary
+
+  gem.homepage = "http://github.com/mavenlink/metriks-dogstatsd"
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename f }
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split "\n"
+  gem.files = `git ls-files`.split "\n"
+
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_rubygems_version = Gem::Requirement.new '>= 1.8.24'
+
+  gem.add_dependency 'metriks', '~> 0.9.9.2'
+  gem.add_dependency 'dogstatsd-ruby', '= 1.1.0' # we reach into some internals, hence the hard dep
+
+  # Testing
+  gem.add_development_dependency 'rake', '~> 0.9.2'
+  gem.add_development_dependency 'mocha', '~> 0.12.3'
+
+end

data/test/helper.rb

@@ -0,0 +1,38 @@
+require 'bundler/setup'
+
+require 'test/unit'
+require 'pp'
+
+require 'mocha'
+
+require 'metriks'
+
+# metriks uses threads so we need to ensure
+# that the thread dies if things fail badly
+Thread.abort_on_exception = true
+
+module ThreadHelper
+  require 'thread'
+
+  # Run the given block on n threads in parallel. Returns an array of the
+  # return values of each thread's last invocation of block. Options:
+
+  # :n: call block n times per thread. Default 1.
+  def thread(threads = 2, option = {})
+    n = opts[:n] || 1
+    results = []
+
+    threads.times.map do |i|
+      Thread.new do
+        n.times do
+          results[i] = yield i
+        end
+      end
+    end.each do |thread|
+      thread.join
+    end
+
+    results
+  end
+
+end

data/test/test_dogstatsd_reporter.rb

@@ -0,0 +1,89 @@
+require 'helper'
+require 'metriks/reporter/dogstatsd'
+
+class DogStatsdReporterTest < Test::Unit::TestCase
+
+  class UDPSocketInterceptor < UDPSocket
+    def self.send *args
+      # intercept and throw away any sent packets
+    end
+  end
+
+  def setup(options = {})
+    @registry = Metriks::Registry.new
+    
+    @reporter = Metriks::Reporter::DogStatsd.new 'localhost', 8125, :registry => @registry, :prefix => options[:reporter_prefix], :timeout_seconds => options[:timeout_seconds], :on_error => options[:on_error]
+    @statsd_client = @reporter.client
+    
+    # here we intercept the actual output routine so that we can inspect what would
+    # really be going to the DogStatsD host
+    @reporter.socket = UDPSocketInterceptor
+  end
+
+  def teardown
+    @reporter.stop
+    @registry.stop
+  end
+
+  def flush_reporter
+    @reporter.write
+  end
+
+  def test_meter
+    number_of_times_marked = 10
+    
+    @statsd_client.expects(:count).once.with('meter.testing', number_of_times_marked)
+    
+    number_of_times_marked.times do
+      @registry.meter('meter.testing').mark
+    end
+    
+    flush_reporter
+  end
+
+  def test_counter
+    @statsd_client.expects(:count).once.with('counter.testing', 1)
+    
+    @registry.counter('counter.testing').increment
+    flush_reporter
+  end
+
+  def test_timer
+    @statsd_client.expects(:histogram).once.with('timer.testing.count', 1)
+    
+    @registry.timer('timer.testing').update(1.5)
+    flush_reporter
+  end
+
+  def test_histogram
+    @statsd_client.expects(:histogram).once.with('histogram.testing.count', 1)
+    
+    @registry.histogram('histogram.testing').update(1.5)
+    flush_reporter
+  end
+
+  def test_utilization_timer
+    @statsd_client.expects(:histogram).once.with('utilization_timer.testing.count', 1)
+    
+    @registry.utilization_timer('utilization_timer.testing').update(1.5)
+    flush_reporter
+  end
+
+  def test_prefixing
+    setup :reporter_prefix => 'test.prefix.xyzzy'
+    
+    @statsd_client.expects(:count).once.with('test.prefix.xyzzy.test.prefixes', 1)
+    
+    @registry.meter('test.prefixes').mark
+    flush_reporter
+  end
+  
+  def test_timeout
+    error_handler_called = false
+    setup :timeout_seconds => 0.0, :on_error => proc{|ex| error_handler_called = true }
+    @registry.meter('test.timeout').mark
+    @reporter.spawn_threaded_write_system.join
+    assert error_handler_called, 'error handler was not called'
+  end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: metriks-dogstatsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin 'J' Lynn
+- Sponsored by Mavenlink, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metriks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9.2
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+description: A DogStatsD compatible reporter for the metriks metric reporting gem
+email:
+- j@jaesharp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/metriks-dogstatsd.rb
+- lib/metriks/reporter/dogstatsd.rb
+- lib/metriks/reporter/dogstatsd/version.rb
+- metriks-dogstatsd.gemspec
+- test/helper.rb
+- test/test_dogstatsd_reporter.rb
+homepage: http://github.com/mavenlink/metriks-dogstatsd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.24
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A DogStatsD compatible reporter for the metriks metric reporting gem
+test_files: []
+has_rdoc: