sidekiq-instrument 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4112a344ff91a81260af18c47e66fbd1806b9340f9bf0f632d84b405b308c39
-  data.tar.gz: 8fddd4f0232f9c9a4b41ec29428e1a39a84c85dacdea09d1b60a0d535af4ff92
+  metadata.gz: 72c5cdbcff6df0e0af5fafd832a738c94ca639713fe370c3543c9b01907270c6
+  data.tar.gz: 7a785e4013569f3857f404fcf6cf38656c7c0eae57e20d8154d7d9c322ddb27b
 SHA512:
-  metadata.gz: b75d3188a1b15368dc70d3f9fca27844f7a8c89dc52f7d632286c9e05268004c969f48ac37b5d11a9747c64342c74723e38873b0616782c8c19e082ba91531c9
-  data.tar.gz: 5508859e81ef17cda16e7582f718f5e36b56ccc836895267927f96d997366340071e035f106252d6b0a9d336c013e451f82222284166b96ee0d26b170a149b9f
+  metadata.gz: b671f7aee1e48345c8e8eda768aef308782c37bc3990075a0e027fc2c3d2eb0ef9b216df928813c592db3d9d0a32c49062c145a9aff35321cd4e4e1bb6fea337
+  data.tar.gz: 6906d370408c343e8cc283fcc61a4cf5315b6ead830108a88d27608da8c244315a790248f5301d7d448664625b02325d741ecd340d861d7cef0935066aad13d8

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: [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/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.4"
+    VERSION = '0.5.6'
   end
 end

data/lib/sidekiq/instrument/worker.rb

@@ -9,10 +9,10 @@ module Sidekiq::Instrument
     # (i.e. the metrics will reported as :processed, :workers, :pending, and :failed).
     # Feel free to override.
     METRIC_NAMES = {
-      processed:    nil,
+      processed: nil,
       workers_size: :workers,
-      enqueued:     :pending,
-      failed:       nil
+      enqueued: :pending,
+      failed: nil
     }
 
     def perform
@@ -28,18 +28,45 @@ module Sidekiq::Instrument
       working = Sidekiq::Workers.new.count
       Statter.statsd.gauge('shared.sidekiq.stats.working', working)
       Statter.dogstatsd&.gauge('sidekiq.working', working)
-
-      info.queues.each do |name, size|
-        Statter.statsd.gauge("shared.sidekiq.#{name}.size", size)
-        Statter.dogstatsd&.gauge('sidekiq.queue.size', size, tags: ["queue:#{name}"])
-      end
-
+      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))
+
         Statter.statsd.gauge("shared.sidekiq.#{queue.name}.latency", queue.latency)
-        Statter.dogstatsd&.gauge('sidekiq.queue.latency', queue.latency, tags: ["queue:#{queue.name}"])
+        Statter.dogstatsd&.gauge('sidekiq.queue.latency', queue.latency, tags: dd_tags(queue))
       end
 
       Statter.dogstatsd&.flush(sync: true)
     end
+
+    private
+
+    # @param [Sidekiq::Queue] queue used for stats emission
+    # @return [Array<String>] an array of tags
+    # @example this method can be override to add more tags
+    #   class MyStatsWorker < Sidekiq::Instrument::Worker
+    #     private
+    #
+    #     def dd_tags(queue)
+    #       custom_tags = []
+    #       queue_type = queue.name.match?(/readonly$/) ? 'read_only'  : 'regular'
+    #       custom_tags << "queue_type:#{queue_type}"
+    #
+    #       super(queue) | custom_tags
+    #     end
+    #   end
+    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.trace.inqueue.#{key}", value)
+        Statter.dogstatsd&.gauge("shared.sidekiq.trace.inqueue.#{key}", value)
+      end
+    end
   end
 end

data/lib/sidekiq/instrument/worker_metrics.rb

@@ -0,0 +1,106 @@
+# 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, :redis_config
+
+      class_attribute :redis_password
+
+      class << self
+        def redis_pool_user
+          @redis_pool_user ||= begin
+            redis_client_config = RedisClient.config(**redis_config)
+            @redis = redis_client_config.new_pool(
+              timeout: 0.5, size: Integer(ENV.fetch('RAILS_MAX_THREADS', 5))
+            )
+          end
+        end
+
+        def reset_redis
+          @redis = nil
+        end
+
+        def trace_workers_increment_counter(klass_name, sidekiq_redis_pool_user)
+          return unless enabled?
+
+          if redis_config?
+            redis_pool_user.with do |redis|
+              redis.call 'HINCRBY', worker_metric_name, klass_name, 1
+            end
+          else
+            sidekiq_redis_pool_user.with do |redis|
+              redis.hincrby worker_metric_name, klass_name, 1
+            end
+          end
+        end
+
+        def trace_workers_decrement_counter(klass_name)
+          return unless enabled?
+
+          if redis_config?
+            redis_pool_user.with do |redis|
+              redis.call 'HINCRBY', worker_metric_name, klass_name, -1
+            end
+          else
+            Sidekiq.redis do |redis|
+              redis.hincrby worker_metric_name, klass_name, -1
+            end
+          end
+        end
+
+        def reset_counters
+          return unless enabled?
+
+          if redis_config?
+            redis_pool_user.with do |redis|
+              all_keys = redis.call 'HGETALL', worker_metric_name
+              redis.call 'HDEL', worker_metric_name, all_keys.keys
+            end
+          else
+            Sidekiq.redis do |redis|
+              all_keys = redis.hgetall worker_metric_name
+              redis.hdel worker_metric_name, all_keys.keys
+            end
+          end
+        end
+
+        def reset_counter(key)
+          return unless enabled?
+
+          if redis_config?
+            redis_pool_user.with do |redis|
+              redis.call 'HDEL', worker_metric_name, key
+            end
+          else
+            Sidekiq.redis do |redis|
+              redis.hdel worker_metric_name, key
+            end
+          end
+        end
+
+        def workers_in_queue
+          return unless enabled?
+
+          if redis_config?
+            redis_pool_user.with do |redis|
+              redis.call 'HGETALL', worker_metric_name
+            end
+          else
+            Sidekiq.redis do |redis|
+              redis.hgetall worker_metric_name
+            end
+          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.11.0"
 
   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.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Loan Application Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-04-04 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.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !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