sidekiq-statsd 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7c691fdc841e5a3f80e8e00ad7fd9b67008f82254d8e73a7b4af06598534559
-  data.tar.gz: c73db3ee678d3fd3078e3c5fcf934e9e3c3b786df72bd5b5402ceb8d97f7e030
+  metadata.gz: 2c0a8286f6068e0cde4639ae549ddb4ffea4b615b5e21be7913e8a911f7a6d5e
+  data.tar.gz: eeacf3e1cacfda19717958059aab50d4f64a645934188530b842c2edd98a94de
 SHA512:
-  metadata.gz: d5058163f365e1bf7f5a96f8796388268003df228cda4cde5a4a38733d5263f58100e198244aa4d990fd0aa864c3b9fc419dd03549f8a078f97bd7b5ef8a7db0
-  data.tar.gz: 62d253d5b5484a372d181bbf3b33cfd577ced1cb5fef22b068d605618911a2b37187cb32ccb810c9283602edbf3349f5e2f529871ea1b5beeee3da422209884b
+  metadata.gz: ed5110d9d73f6e0f7f4d7ba1521ab98af4187aeb271cbadc3c880af499cefab64a79da9aa87b9797ce8d75170f0c5bf209d22dc18671cc3f02f524c1e355c7fc
+  data.tar.gz: 5cbf10d942527cdc0e7ea3c43ee0e08ef5f14c7b6000673b81d66451c93bcbc2d66017240caea5b6d3f61e076713329f45d79e510b79235aea93ac18efa1ae78

data/.travis.yml

@@ -6,8 +6,7 @@ rvm:
   - 2.5.0
   - 2.6.0
 env:
-  - SIDEKIQ_VERSION="~> 2.7.0"
-  - SIDEKIQ_VERSION="~> 3.0.0"
+  - SIDEKIQ_VERSION="~> 3.3.1"
   - SIDEKIQ_VERSION="~> 4.0.0"
   - SIDEKIQ_VERSION="~> 5.0.0"
   - SIDEKIQ_VERSION="~> 6.0.0"

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 2.0.1
+
+* Fix stuck global stats (retries, processed, etc.)
+
+# 2.0.0
+
+* BREAKING: drop host/port options
+* Add support for custom statsd client
+
 # 1.0.0
 
 * Pin minimum Ruby version to 2.4

data/README.md

@@ -11,8 +11,11 @@ Sidekiq::Statsd is tested against [several Ruby versions](.travis.yml#L4).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
+    gem "statsd-ruby"
+    # or if you are using Datadog
+    # gem "dogstatsd-ruby"
     gem "sidekiq-statsd"
 
 And then execute:
@@ -29,9 +32,16 @@ In a Rails initializer or wherever you've configured Sidekiq, add
 Sidekiq::Statsd to your server middleware:
 
 ```ruby
+require 'statsd'
+statsd = Statsd.new('localhost', 8125)
+
+# or if you are using Datadog
+# require 'datadog/statsd'
+# statsd = Datadog::Statsd.new('localhost', 8125)
+
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    chain.add Sidekiq::Statsd::ServerMiddleware, env: "production", prefix: "worker", host: "localhost", port: 8125
+    chain.add Sidekiq::Statsd::ServerMiddleware, env: "production", prefix: "worker", statsd: statsd
   end
 end
 ```

data/lib/sidekiq/statsd/server_middleware.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'statsd'
-
 module Sidekiq::Statsd
   ##
   # Sidekiq StatsD is a middleware to track worker execution metrics through statsd.
@@ -11,21 +9,14 @@ module Sidekiq::Statsd
     # Initializes the middleware with options.
     #
     # @param [Hash] options The options to initialize the StatsD client.
-    # @option options [Statsd] :statsd Existing statsd client.
+    # @option options [Statsd] :statsd Existing StatsD client.
     # @option options [String] :env ("production") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure).
     # @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.
     def initialize(options = {})
-      @options = { env:            'production',
-                   prefix:         'worker',
-                   host:           'localhost',
-                   port:           8125,
-                   sidekiq_stats:  true }.merge options
+      @options = { env: 'production', prefix: 'worker', sidekiq_stats:  true }.merge options
 
-      @statsd = options[:statsd] || ::Statsd.new(@options[:host], @options[:port])
-      @sidekiq_stats = Sidekiq::Stats.new if @options[:sidekiq_stats]
+      @statsd = options[:statsd] || raise("A StatsD client must be provided")
     end
 
     ##
@@ -49,32 +40,35 @@ module Sidekiq::Statsd
           b.increment prefix(worker_name, 'failure')
           raise e
         ensure
-          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
-          end
-
-          # Queue metrics
-          queue_name = msg['queue']
-          sidekiq_queue = Sidekiq::Queue.new(queue_name)
-          b.gauge prefix('queues', queue_name, 'enqueued'), sidekiq_queue.size
-          if sidekiq_queue.respond_to?(:latency)
-            b.gauge prefix('queues', queue_name, 'latency'), sidekiq_queue.latency
-          end
+          report_global_stats(b) if @options[:sidekiq_stats]
+          report_queue_stats(b, msg['queue'])
         end
       end
     end
 
     private
 
+    def report_global_stats(statsd)
+      sidekiq_stats = Sidekiq::Stats.new
+
+      # Queue sizes
+      statsd.gauge prefix('enqueued'), sidekiq_stats.enqueued
+      statsd.gauge prefix('retry_set_size'), sidekiq_stats.retry_size
+
+      # All-time counts
+      statsd.gauge prefix('processed'), sidekiq_stats.processed
+      statsd.gauge prefix('failed'), sidekiq_stats.failed
+    end
+
+    def report_queue_stats(statsd, queue_name)
+      sidekiq_queue = Sidekiq::Queue.new(queue_name)
+      statsd.gauge prefix('queues', queue_name, 'enqueued'), sidekiq_queue.size
+
+      if sidekiq_queue.respond_to?(:latency)
+        statsd.gauge prefix('queues', queue_name, 'latency'), sidekiq_queue.latency
+      end
+    end
+
     ##
     # Converts args passed to it into a metric name with prefix.
     #

data/lib/sidekiq/statsd/version.rb

@@ -1,6 +1,6 @@
 module Sidekiq
   module Statsd
-    VERSION = '1.0.0'
+    VERSION = '2.0.1'
   end
 end
 

data/sidekiq-statsd.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "activesupport"
-  gem.add_dependency "sidekiq", ">= 2.7"
-  gem.add_dependency "statsd-ruby", ">= 1.1.0"
+  gem.add_dependency "sidekiq", ">= 3.3.1"
 
   gem.required_ruby_version = '>= 2.4.0'
 end

data/spec/sidekiq/statsd/server_middleware_spec.rb

@@ -1,12 +1,12 @@
 require "spec_helper"
 
 describe Sidekiq::Statsd::ServerMiddleware do
-  subject(:middleware) { described_class.new }
+  subject(:middleware) { described_class.new(statsd: client) }
 
   let(:worker) { double "Dummy worker" }
   let(:msg)    { { 'queue' => 'mailer' } }
   let(:queue)  { nil }
-  let(:client) { double(::Statsd).as_null_object }
+  let(:client) { double('StatsD').as_null_object }
 
   let(:worker_name) { worker.class.name.gsub("::", ".") }
 
@@ -14,28 +14,15 @@ describe Sidekiq::Statsd::ServerMiddleware do
   let(:broken_job) { ->{ raise 'error' } }
 
   before do
-    allow_any_instance_of(::Statsd).to receive(:batch).and_yield(client)
+    allow(client).to receive(:batch).and_yield(client)
   end
 
-  it "doesn't initialize a ::Statsd client if passed-in" do
-    expect(::Statsd)
-      .to receive(:new)
-      .never
-
-    described_class.new(statsd: client)
+  it "raises error if no statsd supplied" do
+    expect { described_class.new }.to raise_error("A StatsD client must be provided")
   end
 
   context "with customised options" do
     describe "#new" do
-      it "uses the custom statsd host and port" do
-        expect(::Statsd)
-          .to receive(:new)
-          .with('example.com', 8126)
-          .once
-
-        described_class.new(host: 'example.com', port: 8126)
-      end
-
       it "uses the custom metric name prefix options" do
         expect(client)
           .to receive(:time)
@@ -44,31 +31,27 @@ describe Sidekiq::Statsd::ServerMiddleware do
           .and_yield
 
         described_class
-          .new(env: 'development', prefix: 'application.sidekiq')
+          .new(statsd: client, env: 'development', prefix: 'application.sidekiq')
           .call(worker, msg, queue, &clean_job)
       end
     end
   end
 
   context 'without global sidekiq stats' do
-    let(:sidekiq_stats) { double }
-
-    it "doesn't initialze a Sidekiq::Stats instance" do
+    it "doesn't initialize 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
+      expect(Sidekiq::Stats).not_to receive(:new)
+      described_class.new(statsd: client, sidekiq_stats: false)
     end
 
     it "doesn't gauge sidekiq stats" do
-      allow(Sidekiq::Stats).to receive(:new) { 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)
+      expect(client).not_to receive(:enqueued)
+      expect(client).not_to receive(:retry_size)
+      expect(client).not_to receive(:processed)
+      expect(client).not_to receive(:failed)
 
       described_class
-        .new(sidekiq_stats: false)
+        .new(statsd: client, sidekiq_stats: false)
         .call(worker, msg, queue, &clean_job)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
-- !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
+        version: 3.3.1
 description: Sidekiq StatsD is a Sidekiq server middleware to send Sidekiq worker
   metrics through statsd.
 email: