yabeda-sidekiq 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c513f6e9028c0bc3a385488105d314a5c7e7ba9ef795bcbd07895d21fe80c8a
-  data.tar.gz: d76ba8c2d976a4ba2356713fc40b9c8ed7720aa8ddd15adc08f5d338a8d06604
+  metadata.gz: 56cc207100137641a1ba2cd7151f411473a003623f4316f470c9cab2734b0c46
+  data.tar.gz: ab292a2728a35ab4ed163f9d77e4260d33944052fb384c93895fceddcdd63876
 SHA512:
-  metadata.gz: f99e5b2d9a108a659affa0f14d3b0528377485616b6213f2f06eb0c2744d2c6e9d97051a0f56ee4aa1757b1ee4109bda42fd7c66b23f656b4764ce7c06ac039e
-  data.tar.gz: 916fe6c0019e72bbe444cc75a5d3ec8ab27d174eb688e7de121f31b80a1280b522c5c0902dd5839946cd9d3ef9387704126cce295171889b72b0ffc998a8b796
+  metadata.gz: 225fdd8793b40a5efc4ae7a476e90e142cf2a1b8b790d395262d76f7a7ad8f73d7f9969f7cfe7dcb87359eee272bfa9ab5dac08b7ff477961814f70daa81f676
+  data.tar.gz: 7673942008c4c0b83d57fa681016f6b4238107f3c355165fa616191a9a6f8d339828830d3e7fff03d9f3d80e67a1f657756459d87aecd0681547ba6060b2fe7e

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.5.0 - 2020-02-20
+
+### Added
+
+ - New `sidekiq_job_latency` histogram to track latency statistics of different job classes. [#9](https://github.com/yabeda-rb/yabeda-sidekiq/pull/9) by [@asusikov]
+
+### Changed
+
+ - **BREAKING CHANGE!** Renamed `sidekiq_jobs_latency` gauge to `sidekiq_queue_latency` to better describe its purpose and differentiate with the new histogram. [#9](https://github.com/yabeda-rb/yabeda-sidekiq/pull/9) by [@asusikov]
+
 ## 0.2.0 - 2020-01-14
 
 ### Changed
@@ -40,3 +50,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
  - Initial release of evil-metrics-sidekiq gem. @Envek
 
 [@dsalahutdinov]: https://github.com/dsalahutdinov "Salahutdinov Dmitry"
+[@asusikov]: https://github.com/asusikov "Alexander Susikov"

data/README.md

@@ -2,6 +2,8 @@
 
 Built-in metrics for [Sidekiq] monitoring out of the box! Part of the [yabeda] suite.
 
+Sample Grafana dashboard ID: [11667](https://grafana.com/grafana/dashboards/11667)
+
 ## Installation
 
 ```ruby
@@ -31,7 +33,8 @@ end
  - Number of jobs have been finished successfully: `sidekiq_jobs_success_total` (segmented by queue and class name)
  - Number of jobs have been failed: `sidekiq_jobs_failed_total` (segmented by queue and class name)
  - Time of job run: `sidekiq_job_runtime` (seconds per job execution, segmented by queue and class name)
- - Time of the queue latency `sidekiq_jobs_latency` (the difference in seconds since the oldest job in the queue was enqueued)
+ - Time of the queue latency `sidekiq_queue_latency` (the difference in seconds since the oldest job in the queue was enqueued)
+ - Time of the job latency `sidekiq_job_latency` (the difference in seconds since the enqueuing until running job)
  - Number of jobs in queues: `sidekiq_jobs_waiting_count` (segmented by queue)
  - Number of scheduled jobs:`sidekiq_jobs_scheduled_count`
  - Number of jobs in retry set: `sidekiq_jobs_retry_count`

data/lib/yabeda/sidekiq.rb

@@ -32,8 +32,12 @@ module Yabeda
       gauge     :jobs_retry_count,     tags: [],        comment: "The number of failed jobs waiting to be retried"
       gauge     :jobs_dead_count,      tags: [],        comment: "The number of jobs exceeded their retry count."
       gauge     :active_processes,     tags: [],        comment: "The number of active Sidekiq worker processes."
-      gauge     :jobs_latency,         tags: %i[queue], comment: "The job latency, the difference in seconds since the oldest job in the queue was enqueued"
+      gauge     :queue_latency,        tags: %i[queue], comment: "The queue latency, the difference in seconds since the oldest job in the queue was enqueued"
 
+      histogram :job_latency, comment: "The job latency, the difference in seconds between enqueued and running time",
+                              unit: :seconds, per: :job,
+                              tags: %i[queue worker],
+                              buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
       histogram :job_runtime, comment: "A histogram of the job execution time.",
                               unit: :seconds, per: :job,
                               tags: %i[queue worker],
@@ -52,7 +56,7 @@ module Yabeda
         sidekiq_jobs_retry_count.set({}, stats.retry_size)
 
         ::Sidekiq::Queue.all.each do |queue|
-          sidekiq_jobs_latency.set({ queue: queue.name }, queue.latency)
+          sidekiq_queue_latency.set({ queue: queue.name }, queue.latency)
         end
 
         # That is quite slow if your retry set is large

data/lib/yabeda/sidekiq/server_middleware.rb

@@ -8,6 +8,8 @@ module Yabeda
         labels = Yabeda::Sidekiq.labelize(worker, job, queue)
         start = Time.now
         begin
+          job_instance = ::Sidekiq::Job.new(job)
+          Yabeda.sidekiq_job_latency.measure(labels, job_instance.latency)
           yield
           Yabeda.sidekiq_jobs_success_total.increment(labels)
         rescue Exception # rubocop: disable Lint/RescueException

data/lib/yabeda/sidekiq/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Sidekiq
-    VERSION = "0.2.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda