sidekiq-instrument 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c79cacef1cb058038cfd3c55495349dbbd4b4c023114bb4760e83868647a9b1
-  data.tar.gz: c2c1ad52812042a210fc7549b48520977ec33836b850b17110002d3b23d442d4
+  metadata.gz: 80c86d5df7ca90b39edcb4c60ca4a92e1c1e128584bbc78be60f4dd6f75b3d19
+  data.tar.gz: 5e6807e9553c968e8ddb61f1cc7061e8798d4e1aca6257ebab86eb29bfd5f3d2
 SHA512:
-  metadata.gz: c586597549a8eb0a7002ea2f1b290737a39d5fb08f66565f613c5f77448c32027f961b44a3c2cd743f05f80f0bdaf3e4fcc8297357e8b3f6eb43bd3b25d0c14a
-  data.tar.gz: 88d1aee1549d0189be4c6e71cefdb6dc7d975f932c9e47b20ce7b9245646f2eb01d29e2b079e300197afa028888c9e26c2e5eefbebed4fdf8d20013170667fb4
+  metadata.gz: dca33f186fe4ca74db99a2fe8836047a5bfd499f435c28ebd20601835e43553cabb5565713ea17c2d7e08a5e68bb516622033674dfe5ef96496c8ff56b07ee79
+  data.tar.gz: b41c82a0b3d99eaea85fcbf00bcd631a04dc69edd152a849066866dc132ded2ceb9514277f5842fe33944c0c0141016672ab2fca20d26de5130e3d7f56c22e45

data/README.md

@@ -75,16 +75,19 @@ 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_.success**: counter incremented each time a job succeeds.
+5. **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
+6. **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 +106,16 @@ 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.success (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a job succeeds.
+5. **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
+6. **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 +133,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,12 +12,18 @@ 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, job))

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

@@ -17,6 +17,8 @@ module Sidekiq::Instrument
       execution_time_ms = (Time.now - start_time) * 1000
       Statter.dogstatsd&.timing('sidekiq.runtime', execution_time_ms, worker_dog_options(worker, job))
       Statter.statsd.measure(metric_name(worker, 'runtime'), execution_time_ms)
+      Statter.dogstatsd&.increment('sidekiq.success', worker_dog_options(worker, job))
+      Statter.statsd.increment(metric_name(worker, 'success'))
     rescue Exception => e
       dd_options = worker_dog_options(worker, job)
       dd_options[:tags] << "error:#{e.class.name}"

data/lib/sidekiq/instrument/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Instrument
-    VERSION = '0.7.3'
+    VERSION = '0.7.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrument
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Loan Application Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq