sidekiq-statsd 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e33d3802f9cdc7d435e1e4338f7828f96534f4e
-  data.tar.gz: b9db8a5236e5a708fd89af15fdd2c8308afe0214
+  metadata.gz: 0e70c72f2d9107ff88383d3e2f8a90fdddc8ec22
+  data.tar.gz: bf3d374265929d5955fcffd003b30f32182134da
 SHA512:
-  metadata.gz: 362cd5bdb3f38aae086478fd7068f1cd525959f31dad78ab8eaed707f593055894575c284b1e24e7f2f6fa094d1b7928d35c9af3c86aee31646af79c2cd3de47
-  data.tar.gz: da265304addf998d858dded40984207f6819a376d40a423217eb0e5e625e7dae324698e2b89c87ccba4895a76021256e5b136410491fd072a5da5cc12202ef88
+  metadata.gz: 4a07e5fd441caf1440f02926a7cef1972413ad11fb68a06574e5eca8530299a74f03acc068481fb63f28df63ebb27dc5736fc627fcac343c3d70fd9ce3732083
+  data.tar.gz: d8120db511be1257e6f6c7f7cce380806145d93b2f0af4729ff113df2f988dae4c7a04d6b26bfe3a6c121300b2c2346b9278d6157b991a808cee94c68fdf38a3

data/README.md

@@ -45,6 +45,7 @@ end
 # @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).
 # @option options [String] :host ("localhost") The StatsD host.
 # @option options [String] :port ("8125") The StatsD port.
+# @option options [String] :sidekiq_stats ("true") Send Sidekiq global stats e.g. total enqueued, processed and failed.
 ```
 
 If you have a [statsd instance](https://github.com/github/statsd-ruby) you can pass it through the `:statsd` option. If not you can pass the `:host` and `:port` to connect to statsd.

data/lib/sidekiq/statsd/server_middleware.rb

@@ -16,13 +16,16 @@ module Sidekiq::Statsd
     # @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).
     # @option options [String] :host ("localhost") The StatsD host.
     # @option options [String] :port ("8125") The StatsD port.
-    def initialize options={}
-      @options = { env:    "production",
-                   prefix: "worker",
-                   host:   "localhost",
-                   port:   8125 }.merge options
+    # @option options [String] :sidekiq_stats ("true") Send Sidekiq global stats e.g. total enqueued, processed and failed.
+    def initialize(options = {})
+      @options = { env:            'production',
+                   prefix:         'worker',
+                   host:           'localhost',
+                   port:           8125,
+                   sidekiq_stats:  true }.merge options
+
       @statsd = options[:statsd] || ::Statsd.new(@options[:host], @options[:port])
-      @sidekiq_stats = Sidekiq::Stats.new
+      @sidekiq_stats = Sidekiq::Stats.new if @options[:sidekiq_stats]
     end
 
     ##
@@ -34,22 +37,30 @@ module Sidekiq::Statsd
     def call worker, msg, queue
       @statsd.batch do |b|
         begin
-          worker_name = worker.class.name.gsub("::", ".")
+          # colon causes invalid metric names
+          worker_name = worker.class.name.gsub('::', '.')
+
           b.time prefix(worker_name, 'processing_time') do
             yield
           end
+
           b.increment prefix(worker_name, 'success')
         rescue => e
           b.increment prefix(worker_name, 'failure')
           raise e
         ensure
-          # Queue sizes
-          b.gauge prefix('enqueued'), @sidekiq_stats.enqueued
-          b.gauge prefix('retry_set_size'), @sidekiq_stats.retry_size
+          if @options[:sidekiq_stats]
+            # Queue sizes
+            b.gauge prefix('enqueued'), @sidekiq_stats.enqueued
+            if @sidekiq_stats.respond_to?(:retry_size)
+              # 2.6.0 doesn't have `retry_size`
+              b.gauge prefix('retry_set_size'), @sidekiq_stats.retry_size
+            end
 
-          # All-time counts
-          b.gauge prefix('processed'), @sidekiq_stats.processed
-          b.gauge prefix('failed'), @sidekiq_stats.failed
+            # All-time counts
+            b.gauge prefix('processed'),  @sidekiq_stats.processed
+            b.gauge prefix('failed'),     @sidekiq_stats.failed
+          end
 
           # Queue metrics
           queue_name = msg['queue']

data/lib/sidekiq/statsd/version.rb

@@ -1,6 +1,6 @@
 module Sidekiq
   module Statsd
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end
 

data/spec/sidekiq/statsd/server_middleware_spec.rb

@@ -49,6 +49,29 @@ describe Sidekiq::Statsd::ServerMiddleware do
     end
   end
 
+  context 'without global sidekiq stats' do
+    let(:sidekiq_stats) { double }
+
+    it "doesn't initialze a Sidekiq::Stats instance" do
+      # Sidekiq::Stats.new calls fetch_stats!, which makes redis calls
+      expect(described_class.new(sidekiq_stats: false).instance_variable_get(:@sidekiq_stats))
+        .to be_nil
+    end
+
+    it "doesn't gauge sidekiq stats" do
+      Sidekiq::Stats.stub(:new).and_return(sidekiq_stats)
+
+      expect(sidekiq_stats).not_to receive(:enqueued)
+      expect(sidekiq_stats).not_to receive(:retry_size)
+      expect(sidekiq_stats).not_to receive(:processed)
+      expect(sidekiq_stats).not_to receive(:failed)
+
+      described_class
+        .new(sidekiq_stats: false)
+        .call(worker, msg, queue, &clean_job)
+    end
+  end
+
   context "with successful execution" do
     let(:job) { clean_job }
 

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-statsd
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 description: Sidekiq StatsD is a Sidekiq server middleware to send Sidekiq worker
@@ -60,10 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .pryrc
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".pryrc"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -88,17 +88,17 @@ 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.14
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Sidekiq StatsD is a Sidekiq server middleware to send Sidekiq worker metrics