sidekiq_statsd_middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10eddb18f8dcab082e13db6fcbf317727bf57133
+  data.tar.gz: 821263ccabfb151f223e6286318c4b58fcf064df
+SHA512:
+  metadata.gz: 871845d889bba831a57cc7c7569f49354bd355581958b900e9eb6d2fea0c59bc160b08936ad97117a9f2687e6a47fe1de46ec93162d30aeb838038c7768c983a
+  data.tar.gz: 58608e5a1b7098e132cc24c396354e03a838d398097b676edd39abb740a9e38197383cd34cd69569da63c984a1a14abafc68d1cce6c728298233e16c9a3e097e

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    sidekiq_statsd_middleware (0.1.0)
+      activesupport (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    diff-lcs (1.2.4)
+    i18n (0.6.5)
+    multi_json (1.7.9)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  rspec (~> 2.14)
+  sidekiq_statsd_middleware!

data/README.md

@@ -0,0 +1,43 @@
+# sidekiq_statsd_middleware
+
+A Ruby gem that provides a server middleware component for Sidekiq that sends
+worker success and failure counts, and job timing information to StatsD.
+
+## Usage
+
+    statsd_client = Statsd.new
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Sidekiq::Statsd::ServerMiddleware, statsd_client, prefix: "app.production.sidekiq"
+      end
+    end
+
+When a worker with the class of, say, `MyBigJob` executes, you'll see a StatsD
+count appear with the name `app.production.sidekiq.my_big_job.success` or
+`app.production.sidekiq.my_big_job.failure`. The execution timing for the job
+will appear as `app.production.sidekiq.my_big_job.duration` and the latency
+(the time difference between when the job was queued and when the job was executed
+by the worker), will appear as `app.production.sidekiq.my_big_job.latency`. 
+
+## License
+
+Copyright (C) 2013 Tom Taylor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sidekiq/statsd/server_middleware.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/string/inflections'
+
+module Sidekiq
+  module Statsd
+    class ServerMiddleware
+
+      attr_reader :client, :prefix
+
+      def initialize(client, options = {})
+        @client = client
+        @prefix = options.delete(:prefix) || "sidekiq"
+      end
+
+      def call(worker, msg, queue)
+        if msg['enqueued_at']
+          # convert and round to ms
+          latency = ((Time.now.to_f - msg['enqueued_at']) * 1000).round 
+          client.timing(metric_key(worker, "latency"), latency)
+        end
+
+        client.time(metric_key(worker, "duration")) do
+          yield
+        end
+
+        client.increment(metric_key(worker, "success"))
+      rescue => e
+        client.increment(metric_key(worker, "failure"))
+        raise e
+      end
+
+      private
+
+      def metric_key(worker, key)
+        worker_name = worker.class.name.underscore.gsub("/", ".")
+        [prefix, worker_name, key].reject(&:nil?).join(".")
+      end
+    end
+  end
+end
+

data/lib/sidekiq/statsd/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Statsd
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/statsd.rb

@@ -0,0 +1,2 @@
+require 'sidekiq/statsd/version'
+require 'sidekiq/statsd/server_middleware'

data/lib/sidekiq_statsd_middleware.rb

@@ -0,0 +1 @@
+require 'sidekiq/statsd'

data/sidekiq_statsd_middleware.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/statsd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq_statsd_middleware'
+  spec.version       = Sidekiq::Statsd::VERSION
+  spec.authors       = ['Tom Taylor']
+  spec.email         = ['tom@newspaperclub.com']
+  spec.homepage      = 'https://github.com/newspaperclub/sidekiq_statsd_middleware'
+  spec.summary       = 'Server Middleware for Sidekiq to report metrics from workers to StatsD'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/spec/sidekiq/statsd/server_middleware_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'sidekiq/statsd/server_middleware'
+
+class DummyWorker; end
+module DummyModule
+  class DummyWorker; end
+end
+
+module Sidekiq::Statsd
+  describe ServerMiddleware do
+    let(:client) { double }
+    let(:options) { Hash.new }
+
+    subject(:middleware) { ServerMiddleware.new(client, options) }
+
+    its(:client) { should == client }
+    its(:prefix) { should == "sidekiq" }
+
+    context 'being called' do
+      let(:worker) do 
+        DummyWorker.new
+      end
+      let(:msg) { { 'enqueued_at' => Time.now.to_f } }
+      let(:queue) { double }
+
+      context 'yielding the worker block' do
+        it 'counts a success and times the duration' do
+          client.should_receive(:time).with("sidekiq.dummy_worker.duration").and_yield
+          client.should_receive(:timing).with("sidekiq.dummy_worker.latency", an_instance_of(Fixnum))
+          client.should_receive(:increment).with("sidekiq.dummy_worker.success")
+          middleware.call(worker, msg, queue) { double }
+        end
+      end
+
+      context 'raising in the worker block' do
+        it 'counts a failure and times the duration' do
+          client.should_receive(:timing).with("sidekiq.dummy_worker.latency", an_instance_of(Fixnum))
+          client.should_receive(:time).with("sidekiq.dummy_worker.duration").and_yield
+          client.should_receive(:increment).with("sidekiq.dummy_worker.failure")
+          expect { middleware.call(worker, msg, queue) { raise } }.to raise_error
+        end
+      end
+
+      context 'without a nil enqueued_at key in the msg' do
+        let(:msg) { Hash.new }
+
+        it 'should not time the latency' do
+          client.should_receive(:time).with("sidekiq.dummy_worker.duration").and_yield
+          client.should_receive(:increment).with("sidekiq.dummy_worker.success")
+          client.should_not_receive(:timing)
+          middleware.call(worker, msg, queue) { double }
+        end
+      end
+    end
+
+    context 'with a prefix' do
+      let(:options) { { :prefix => "foo"} }
+      its(:prefix) { should == "foo" }
+
+      context 'being called successfully' do
+        let(:worker) do 
+          DummyWorker.new
+        end
+        let(:msg) { { 'enqueued_at' => Time.now.to_f } }
+        let(:queue) { double }
+
+        it 'should count with the correct prefix' do
+          client.should_receive(:time).with("foo.dummy_worker.duration").and_yield
+          client.should_receive(:timing).with("foo.dummy_worker.latency", an_instance_of(Fixnum))
+          client.should_receive(:increment).with("foo.dummy_worker.success")
+          middleware.call(worker, msg, queue) { double }
+        end
+      end
+    end
+
+    context 'with a worker class containing a namespace' do
+      let(:worker) do 
+        DummyModule::DummyWorker.new
+      end
+      let(:msg) { { 'enqueued_at' => Time.now.to_f } }
+      let(:queue) { double }
+
+      it 'should count with the correct prefix' do
+        client.should_receive(:time).with("sidekiq.dummy_module.dummy_worker.duration").and_yield
+        client.should_receive(:timing).with("sidekiq.dummy_module.dummy_worker.latency", an_instance_of(Fixnum))
+        client.should_receive(:increment).with("sidekiq.dummy_module.dummy_worker.success")
+        middleware.call(worker, msg, queue) { double }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_statsd_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 
+email:
+- tom@newspaperclub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/sidekiq/statsd.rb
+- lib/sidekiq/statsd/server_middleware.rb
+- lib/sidekiq/statsd/version.rb
+- lib/sidekiq_statsd_middleware.rb
+- sidekiq_statsd_middleware.gemspec
+- spec/sidekiq/statsd/server_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/newspaperclub/sidekiq_statsd_middleware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Server Middleware for Sidekiq to report metrics from workers to StatsD
+test_files:
+- spec/sidekiq/statsd/server_middleware_spec.rb
+- spec/spec_helper.rb