sidekiq-instrument 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a0f783ab0e59fc566b949266b79f362a76d7c99cd15886e5d09b01b26f08f0
-  data.tar.gz: b7d615af7a4884543ef3e7a5a585186fa0f93f1627fe9f5eac0576835b449136
+  metadata.gz: 06c38373f208fd6ec2ed7d3ab01f8cd763d71cc5c44a1684eeaebc824eed489d
+  data.tar.gz: 5207e4868b8190e4a1501977a1736265c501b179fdb66bc0945da9128f3aff66
 SHA512:
-  metadata.gz: 95343856da7a9cad0f41dbcfe4731a4837782ac13bf9f4b515579f45f4326b7f25e4d7c85c5e1ea7ef519f271cd1b6aa7f16c62c89e9c02acb412b1b321e57f8
-  data.tar.gz: dfd0394b47aba69c43e58feabd778dc38091f8e0e61a4c75086c23bf7504fcb294881f3102bbe4de8dbd85223ecf024bdc27721a615bfa6f46df298153a7c186
+  metadata.gz: '0380968a8a88a122fea11c487126ce03094a02db41749c663966a2317aa0892a96fd966d373160477a9855e52421bb7d7c2892dcc42ea78f27ed1a7c42704fd1'
+  data.tar.gz: a89416da29a199afdb5930a62ad2bb479bdccac9b4a4af378094e53d3139d41a867f0af69920a03096d43e7ed7f2e6d9145c70c9a1fc4a34e9836506dcfa0656

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         ruby-version: [2.6, 2.7, 3.0]
-        redis-version: [4, 5, 6]
+        redis-version: [4, 5, 6, 7]
 
     steps:
       - name: Checkout project
@@ -28,7 +28,7 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
 
       - name: Start Redis
-        uses: supercharge/redis-github-action@1.4.0
+        uses: supercharge/redis-github-action@1.5.0
         with:
           redis-version: ${{ matrix.redis-version }}
 

data/README.md

@@ -67,6 +67,9 @@ Sidekiq.configure_client do |config|
     chain.add Sidekiq::Instrument::ClientMiddleware
   end
 end
+
+Sidekiq::Instrument::WorkerMetrics.enabled = true # Set true to enable worker metrics
+Sidekiq::Instrument::WorkerMetrics.namespace = <APP_NAME>
 ```
 
 ## StatsD Keys
@@ -78,7 +81,7 @@ For each job, the following metrics will be reported:
    worker begins performing a job.
 3. **shared.sidekiq._queue_._job_.runtime**: timer of the total time spent
    in `perform`, in milliseconds.
-3. **shared.sidekiq._queue_._job_.error**: counter incremented each time a
+4. **shared.sidekiq._queue_._job_.error**: counter incremented each time a
    job fails.
 
 The metric names can be changed by overriding the `statsd_metric_name`
@@ -86,7 +89,10 @@ method in your worker classes.
 
 For each queue, the following metrics will be reported:
 1. **shared.sidekiq._queue_.size**: gauge of how many jobs are in the queue
-1. **shared.sidekiq._queue_.latency**: gauge of how long the oldest job has been in the queue
+2. **shared.sidekiq._queue_.latency**: gauge of how long the oldest job has been in the queue
+
+For each worker, the following metrics and tags will be reported:
+1. **sidekiq.worker_metrics.inqueue.#{key}**: number of jobs "in queue" per worker, uses redis to track increment/decrement
 
 ## DogStatsD Keys
 For each job, the following metrics and tags will be reported:
@@ -97,12 +103,15 @@ For each job, the following metrics and tags will be reported:
    worker begins performing a job.
 3. **sidekiq.runtime (tags: {queue: _queue_, worker: _job_})**: timer of the total time spent
    in `perform`, in milliseconds.
-3. **sidekiq.error (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+4. **sidekiq.error (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
    job fails.
 
 For each queue, the following metrics and tags will be reported:
 1. **sidekiq.queue.size (tags: {queue: _queue_})**: gauge of how many jobs are in the queue
-1. **sidekiq.queue.latency (tags: {queue: _queue_})**: gauge of how long the oldest job has been in the queue
+2. **sidekiq.queue.latency (tags: {queue: _queue_})**: gauge of how long the oldest job has been in the queue
+
+For each worker, the following metrics and tags will be reported:
+1. **sidekiq.worker_metrics.inqueue.#{key}**: number of jobs "in queue" per worker, uses redis to track increment/decrement
 
 ## Worker
 There is a worker, `Sidekiq::Instrument::Worker`, that submits gauges

data/lib/sidekiq/instrument/middleware/client.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'sidekiq/instrument/mixin'
+require 'active_support/core_ext/string/inflections'
 
 module Sidekiq::Instrument
   class ClientMiddleware
@@ -10,6 +13,7 @@ module Sidekiq::Instrument
       class_instance = klass.new
       Statter.statsd.increment(metric_name(class_instance, 'enqueue'))
       Statter.dogstatsd&.increment('sidekiq.enqueue', worker_dog_options(class_instance))
+      WorkerMetrics.trace_workers_increment_counter(klass.name.underscore, redis_pool)
       result = yield
       Statter.dogstatsd&.flush(sync: true)
       result

data/lib/sidekiq/instrument/middleware/instrument.rb

@@ -0,0 +1,14 @@
+require "active_support/core_ext/class/attribute"
+require "statsd/instrument"
+
+require "sidekiq/instrument/statter"
+require "sidekiq/instrument/version"
+require "sidekiq/instrument/worker"
+require "sidekiq/instrument/middleware/client"
+require "sidekiq/instrument/middleware/server"
+require "sidekiq/instrument/worker_metrics"
+
+module Sidekiq
+  module Instrument
+  end
+end

data/lib/sidekiq/instrument/middleware/server.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'sidekiq/instrument/mixin'
+require 'active_support/core_ext/string/inflections'
 
 module Sidekiq::Instrument
   class ServerMiddleware
@@ -9,6 +12,7 @@ module Sidekiq::Instrument
       Statter.dogstatsd&.increment('sidekiq.dequeue', worker_dog_options(worker))
 
       start_time = Time.now
+      WorkerMetrics.trace_workers_decrement_counter(worker.class.to_s.underscore)
       yield block
       execution_time_ms = (Time.now - start_time) * 1000
       Statter.statsd.measure(metric_name(worker, 'runtime'), execution_time_ms)
@@ -22,4 +26,3 @@ module Sidekiq::Instrument
     end
   end
 end
-

data/lib/sidekiq/instrument/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Instrument
-    VERSION = '0.5.5'
+    VERSION = '0.6.0'
   end
 end

data/lib/sidekiq/instrument/worker.rb

@@ -28,7 +28,7 @@ module Sidekiq::Instrument
       working = Sidekiq::Workers.new.count
       Statter.statsd.gauge('shared.sidekiq.stats.working', working)
       Statter.dogstatsd&.gauge('sidekiq.working', working)
-
+      send_worker_metrics
       Sidekiq::Queue.all.each do |queue|
         Statter.statsd.gauge("shared.sidekiq.#{queue.name}.size", queue.size)
         Statter.dogstatsd&.gauge('sidekiq.queue.size', queue.size, tags: dd_tags(queue))
@@ -59,5 +59,14 @@ module Sidekiq::Instrument
     def dd_tags(queue)
       ["queue:#{queue.name}"]
     end
+
+    def send_worker_metrics
+      return unless WorkerMetrics.enabled
+
+      WorkerMetrics.workers_in_queue.each do |key, value|
+        Statter.statsd.gauge("shared.sidekiq.worker_metrics.inqueue.#{key}", value)
+        Statter.dogstatsd&.gauge("shared.sidekiq.worker_metrics.inqueue.#{key}", value)
+      end
+    end
   end
 end

data/lib/sidekiq/instrument/worker_metrics.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'redis-client'
+module Sidekiq
+  module Instrument
+    # Stores worker count with a key sidekiq_instrument_trace_workers:#{namespace}:in_queue
+    # Values are hash having keys as worker names.
+    class WorkerMetrics
+      class_attribute :enabled, :namespace
+
+      class << self
+        def trace_workers_increment_counter(klass_name, sidekiq_redis_pool_user)
+          return unless enabled?
+
+          Sidekiq.redis do |redis|
+            redis.hincrby(worker_metric_name, klass_name, 1)
+          end
+        end
+
+        def trace_workers_decrement_counter(klass_name)
+          return unless enabled?
+
+          Sidekiq.redis do |redis|
+            redis.hincrby(worker_metric_name, klass_name, -1)
+          end
+        end
+
+        def reset_counters
+          return unless enabled?
+
+          Sidekiq.redis do |redis|
+            all_keys = redis.hgetall(worker_metric_name)
+            redis.hdel(worker_metric_name, all_keys.keys)
+          end
+        end
+
+        def reset_counter(key)
+          return unless enabled?
+
+          Sidekiq.redis do |redis|
+            redis.hdel(worker_metric_name, key)
+          end
+        end
+
+        def workers_in_queue
+          return unless enabled?
+          Sidekiq.redis do |redis|
+            redis.hgetall(worker_metric_name)
+          end
+        end
+
+        def worker_metric_name
+          "sidekiq_instrument_trace_workers:#{namespace}:in_queue"
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/instrument.rb

@@ -6,6 +6,7 @@ require "sidekiq/instrument/version"
 require "sidekiq/instrument/worker"
 require "sidekiq/instrument/middleware/client"
 require "sidekiq/instrument/middleware/server"
+require "sidekiq/instrument/worker_metrics"
 
 module Sidekiq
   module Instrument

data/sidekiq-instrument.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'statsd-instrument', '>= 2.0.4'
   spec.add_dependency 'dogstatsd-ruby', '~> 5.5'
   spec.add_dependency 'activesupport', '>= 5.1', '< 7'
+  spec.add_dependency "redis-client", ">= 0.14.1"
 
   spec.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.2'
   spec.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrument
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Loan Application Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -78,6 +78,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -187,11 +201,13 @@ files:
 - bin/setup
 - lib/sidekiq/instrument.rb
 - lib/sidekiq/instrument/middleware/client.rb
+- lib/sidekiq/instrument/middleware/instrument.rb
 - lib/sidekiq/instrument/middleware/server.rb
 - lib/sidekiq/instrument/mixin.rb
 - lib/sidekiq/instrument/statter.rb
 - lib/sidekiq/instrument/version.rb
 - lib/sidekiq/instrument/worker.rb
+- lib/sidekiq/instrument/worker_metrics.rb
 - sidekiq-instrument.gemspec
 homepage: https://github.com/enova/sidekiq-instrument
 licenses:
@@ -212,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: StatsD & DogStatsD Instrumentation for Sidekiq