sidekiq-statsd 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c0a8286f6068e0cde4639ae549ddb4ffea4b615b5e21be7913e8a911f7a6d5e
-  data.tar.gz: eeacf3e1cacfda19717958059aab50d4f64a645934188530b842c2edd98a94de
+  metadata.gz: e6d8e3354a5bc87cb290fa801fe88fd84af3c6903cc0177f80a95769b29dee43
+  data.tar.gz: d4be3f1f2e8d80c43ace8e07fa86daabb53b8060cccc0a0ba6f27dc992f98019
 SHA512:
-  metadata.gz: ed5110d9d73f6e0f7f4d7ba1521ab98af4187aeb271cbadc3c880af499cefab64a79da9aa87b9797ce8d75170f0c5bf209d22dc18671cc3f02f524c1e355c7fc
-  data.tar.gz: 5cbf10d942527cdc0e7ea3c43ee0e08ef5f14c7b6000673b81d66451c93bcbc2d66017240caea5b6d3f61e076713329f45d79e510b79235aea93ac18efa1ae78
+  metadata.gz: b73d03dd5d3a6cc0f3a41e06f0b5be7b065fe30f2d45198a5acba85f34caee0e1542b2ee607701df9f63cd49dd0e78289f803ec71b04f76c17ad2603349faf3b
+  data.tar.gz: 406fde1d9d0a9686704e31c50a66b191d81a5f5a7c6cc5986467e223c2cf6507d92979a1e4f5b5dc0b26e95853943508b024bc6c78c7891f73e754bdc52de4c0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.1.0
+
+* Report stats across all workers (processing, runtime)
+
 # 2.0.1
 
 * Fix stuck global stats (retries, processed, etc.)

data/README.md

@@ -3,7 +3,12 @@
 [![Build Status](https://secure.travis-ci.org/phstc/sidekiq-statsd.png)](http://travis-ci.org/phstc/sidekiq-statsd)
 [![Dependency Status](https://gemnasium.com/phstc/sidekiq-statsd.png)](https://gemnasium.com/phstc/sidekiq-statsd)
 
-Sidekiq StatsD is a [Sidekiq server middleware](https://github.com/mperham/sidekiq/wiki/Middleware) to send [Sidekiq worker metrics](https://github.com/mperham/sidekiq/wiki/API#wiki-stats) through [statsd](https://github.com/reinh/statsd).
+Sidekiq StatsD is a [Sidekiq server middleware](https://github.com/mperham/sidekiq/wiki/Middleware) to send Sidekiq metrics through [statsd](https://github.com/reinh/statsd):
+
+  - [global metrics](https://github.com/mperham/sidekiq/wiki/API#wiki-stats)
+  - [queue metrics](https://github.com/mperham/sidekiq/wiki/API#queue)
+  - [worker metrics](https://github.com/mperham/sidekiq/wiki/API#workers) (`processing`, `runtime`)
+  - job metrics (`processing_time` and `success` / `failure`)
 
 ## Compatibility
 
@@ -50,16 +55,12 @@ end
 
 ```ruby
 # @param [Hash] options The options to initialize the StatsD client.
-# @option options [Statsd] :statsd Existing statsd client to use.
+# @option options [Statsd] :statsd Existing [statsd client](https://github.com/github/statsd-ruby) to use.
 # @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.
 ```
 
-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.
-
 ## Contributing
 
 1. Fork it

data/lib/sidekiq/statsd/server_middleware.rb

@@ -41,6 +41,7 @@ module Sidekiq::Statsd
           raise e
         ensure
           report_global_stats(b) if @options[:sidekiq_stats]
+          report_worker_stats(b) if @options[:sidekiq_stats]
           report_queue_stats(b, msg['queue'])
         end
       end
@@ -63,9 +64,20 @@ module Sidekiq::Statsd
     def report_queue_stats(statsd, queue_name)
       sidekiq_queue = Sidekiq::Queue.new(queue_name)
       statsd.gauge prefix('queues', queue_name, 'enqueued'), sidekiq_queue.size
+      statsd.gauge prefix('queues', queue_name, 'latency'), sidekiq_queue.latency
+    end
+
+    def report_worker_stats(statsd)
+      workers = Sidekiq::Workers.new.to_a.map { |_pid, _tid, work| work }
+      worker_groups = workers.group_by { |worker| worker['queue'] }
 
-      if sidekiq_queue.respond_to?(:latency)
-        statsd.gauge prefix('queues', queue_name, 'latency'), sidekiq_queue.latency
+      workers.each do |worker|
+        runtime = Time.now.to_i - worker['run_at']
+        statsd.gauge prefix('queues', worker['queue'], 'runtime'), runtime
+      end
+
+      worker_groups.each do |queue_name, workers|
+        statsd.gauge prefix('queues', queue_name, 'processing'), workers.size
       end
     end
 
@@ -78,3 +90,4 @@ module Sidekiq::Statsd
     end
   end # ServerMiddleware
 end # Sidekiq
+

data/lib/sidekiq/statsd/version.rb

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

data/spec/sidekiq/statsd/server_middleware_spec.rb

@@ -39,20 +39,15 @@ describe Sidekiq::Statsd::ServerMiddleware do
 
   context 'without global sidekiq stats' do
     it "doesn't initialize a Sidekiq::Stats instance" do
-      # Sidekiq::Stats.new calls fetch_stats!, which makes redis calls
+      # Sidekiq::Stats.new makes redis calls
       expect(Sidekiq::Stats).not_to receive(:new)
       described_class.new(statsd: client, sidekiq_stats: false)
     end
 
-    it "doesn't gauge sidekiq stats" do
-      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(statsd: client, sidekiq_stats: false)
-        .call(worker, msg, queue, &clean_job)
+    it "doesn't initialize a Sidekiq::Workers instance" do
+      # Sidekiq::Workers.new makes redis calls
+      expect(Sidekiq::Workers).not_to receive(:new)
+      described_class.new(statsd: client, sidekiq_stats: false)
     end
   end
 

data/spec/support/shared_examples_for_a_resilient_gauge_reporter.rb

@@ -1,10 +1,16 @@
+require 'active_support/testing/time_helpers'
+
 shared_examples "a resilient gauge reporter" do
+  include ActiveSupport::Testing::TimeHelpers
+
   let(:sidekiq_stats) { double(enqueued: 1, processed: 2, failed: 3, retry_size: 4) }
+  let!(:sidekiq_workers) { [["pid", "tid", { "queue" => "my_queue", "run_at" => Time.now.to_i }]] }
   let(:queue_stats)   { double(size: 3, latency: 4.2) }
 
   before do
     allow(Sidekiq::Stats).to receive(:new) { sidekiq_stats }
     allow(Sidekiq::Queue).to receive(:new).with('mailer') { queue_stats }
+    allow(Sidekiq::Workers).to receive(:new) { sidekiq_workers }
   end
 
   it "gauges enqueued jobs" do
@@ -60,4 +66,24 @@ shared_examples "a resilient gauge reporter" do
 
     middleware.call(worker, msg, queue, &job)
   end
+
+  it "gauges precessing jobs" do
+    expect(client)
+      .to receive(:gauge)
+      .with("production.worker.queues.my_queue.processing", 1)
+      .once
+
+    middleware.call(worker, msg, queue, &job)
+  end
+
+  it "gauges job runtime" do
+    travel_to 5.minutes.from_now
+
+    expect(client)
+      .to receive(:gauge)
+      .with("production.worker.queues.my_queue.runtime", 300)
+      .once
+
+    middleware.call(worker, msg, queue, &job)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-statsd
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport