sidekiq-instrument 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15f6647c70a9728ad1feb253f921cc68994a32256de015a1c45f147b6aff72ec
-  data.tar.gz: c645b679c715dfe90a6713e56a9b2f3720105ffc065249e7eaec9a614e3e67b9
+  metadata.gz: c29103ed3ffc948efe59b49ff4df569bf52a6ced1a953ea9ada47a251b2a2d63
+  data.tar.gz: 1da9a28a99b77c92699a1cbbdccaf2cc7cd95d11a925d2099858ad5ffa616444
 SHA512:
-  metadata.gz: 957b8590030205b27196985aed50e0b4801772ea8a1a7b25f30bc98cb369c8d623b49936d3acd974b5be703925eee0d6f790abffc7b2b05e71bcd481a098399f
-  data.tar.gz: ed94944e7cf926f9f54056d072c493d111ad7070da3917f8650d282f045da8ecd4a2547ffb0789a3ce2e49f40ecd6c4a88b1175adf10dbf5dda2194eb1b23b2f
+  metadata.gz: e28f76f957396f1fa28fbe3f0ca737da2443b5bc70487d0389944454dce6720213257eae502c58b056640ad58388d0787c14eb2b5405217aa97766a7c5cb7a0f
+  data.tar.gz: f99843e887127800d81453e4d569b676ed0a67091d5636d078fc39367bf827d459a1dca21e75d6171cec98799825f72b403ed0358f90dfbda80abcbe6060a7be

data/README.md

@@ -75,16 +75,18 @@ Sidekiq::Instrument::WorkerMetrics.namespace = <APP_NAME>
 ## StatsD Keys
 For each job, the following metrics will be reported:
 
-1. **shared.sidekiq._queue_._job_.enqueue**: counter incremented each time a
+1. **shared.sidekiq._queue_._job_.schedule**: counter incremented each time a
+   job is scheduled to be pushed onto the queue later.
+2. **shared.sidekiq._queue_._job_.enqueue**: counter incremented each time a
    job is pushed onto the queue.
-2. **shared.sidekiq._queue_._job_.dequeue**: counter incremented just before
+3. **shared.sidekiq._queue_._job_.dequeue**: counter incremented just before
    worker begins performing a job.
-3. **shared.sidekiq._queue_._job_.runtime**: timer of the total time spent
+4. **shared.sidekiq._queue_._job_.runtime**: timer of the total time spent
    in `perform`, in milliseconds.
-4. **shared.sidekiq._queue_._job_.error**: counter incremented each time a
+5. **shared.sidekiq._queue_._job_.error**: counter incremented each time a
    job fails.
 
-For job retry attempts, the above 4 metrics will still be reported but the enqueue/dequeue metrics
+For job retry attempts, metrics 2-5 will still be reported but the enqueue/dequeue metrics
 will have a `.retry` appended:
 
 1. **shared.sidekiq._queue_._job_.enqueue.retry**
@@ -103,13 +105,15 @@ For each worker, the following metrics and tags will be reported:
 ## DogStatsD Keys
 For each job, the following metrics and tags will be reported:
 
-1. **sidekiq.enqueue (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+1. **sidekiq.schedule (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+   job is scheduled to be pushed onto the queue later.
+2. **sidekiq.enqueue (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
    job is pushed onto the queue.
-2. **sidekiq.dequeue (tags: {queue: _queue_, worker: _job_})**: counter incremented just before
+3. **sidekiq.dequeue (tags: {queue: _queue_, worker: _job_})**: counter incremented just before
    worker begins performing a job.
-3. **sidekiq.runtime (tags: {queue: _queue_, worker: _job_})**: timer of the total time spent
+4. **sidekiq.runtime (tags: {queue: _queue_, worker: _job_})**: timer of the total time spent
    in `perform`, in milliseconds.
-4. **sidekiq.error (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+5. **sidekiq.error (tags: {queue: _queue_, worker: _job_, error: _errorclass_})**: counter incremented each time a
    job fails.
 
 For job retry attempts, the above 4 metrics will still be reported but the enqueue/dequeue metrics
@@ -127,7 +131,7 @@ For each worker, the following metrics and tags will be reported:
 
 ## Worker
 
-**WARNING: The metrics reported by this Worker are currently inaccurate.**
+**WARNING: The Redis count metrics reported by this Worker are currently inaccurate.**
 
 There is a worker, `Sidekiq::Instrument::Worker`, that submits gauges
 for various interesting statistics; namely, the bulk of the information in `Sidekiq::Stats`

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

@@ -12,15 +12,21 @@ module Sidekiq::Instrument
       klass = Object.const_get(worker_class.to_s)
       class_instance = klass.new
 
-      # This is needed because the ClientMiddleware is called twice for scheduled jobs
-      # - Once when it gets scheduled
-      # - Once when it gets dequeued for processing
-      # We only want to increment the enqueue metric when the job is scheduled and
-      # Sidekiq::Context.current[:class] is only ever set when the job is scheduled
-      if Sidekiq::Context.current[:class].present?
+      # Depending on the type of perform called, this method can be hit either
+      # once or twice for the same Job ID.
+      #
+      # perform_async:
+      #   - once when it is enqueued, with no job['at'] key
+      # perform_in:
+      #   - once when it is scheduled, with job['at'] key
+      #   - once when it is enqueued, without job['at'] key
+      if job['at'].present?
+        Statter.statsd.increment(metric_name(class_instance, 'schedule'))
+        Statter.dogstatsd&.increment('sidekiq.schedule', worker_dog_options(class_instance, job))
+      else
         WorkerMetrics.trace_workers_increment_counter(klass.name.underscore)
         Statter.statsd.increment(metric_name(class_instance, 'enqueue'))
-        Statter.dogstatsd&.increment('sidekiq.enqueue', worker_dog_options(class_instance))
+        Statter.dogstatsd&.increment('sidekiq.enqueue', worker_dog_options(class_instance, job))
       end
 
       Statter.dogstatsd&.flush(sync: true)

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

@@ -9,16 +9,16 @@ module Sidekiq::Instrument
 
     def call(worker, job, _queue, &block)
       dequeue_string = is_retry(job) ? 'dequeue.retry' : 'dequeue'
-      Statter.dogstatsd&.increment("sidekiq.#{dequeue_string}", worker_dog_options(worker))
+      Statter.dogstatsd&.increment("sidekiq.#{dequeue_string}", worker_dog_options(worker, job))
       Statter.statsd.increment(metric_name(worker, dequeue_string))
 
       start_time = Time.now
       yield block
       execution_time_ms = (Time.now - start_time) * 1000
-      Statter.dogstatsd&.timing('sidekiq.runtime', execution_time_ms, worker_dog_options(worker))
+      Statter.dogstatsd&.timing('sidekiq.runtime', execution_time_ms, worker_dog_options(worker, job))
       Statter.statsd.measure(metric_name(worker, 'runtime'), execution_time_ms)
     rescue Exception => e
-      dd_options = worker_dog_options(worker)
+      dd_options = worker_dog_options(worker, job)
       dd_options[:tags] << "error:#{e.class.name}"
 
       # if we have retries left, increment the enqueue.retry counter to indicate the job is going back on the queue

data/lib/sidekiq/instrument/mixin.rb

@@ -8,8 +8,13 @@ module Sidekiq::Instrument
       end
     end
 
-    def worker_dog_options(worker)
-      { tags: ["queue:#{queue_name(worker)}", "worker:#{underscore(class_name(worker))}"] }
+    def worker_dog_options(worker, job)
+      {
+        tags: [
+          "queue:#{queue_name(worker)}",
+          "worker:#{underscore(class_name(worker))}"
+        ].concat(job.fetch('tags', []))
+      }
     end
 
     def max_retries(worker)

data/lib/sidekiq/instrument/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Instrument
-    VERSION = '0.7.2'
+    VERSION = '0.7.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrument
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Loan Application Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: StatsD & DogStatsD Instrumentation for Sidekiq