sidekiq-health 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81bb187af9420b1b278749905046150a361654f
-  data.tar.gz: 443e051e0878485318ff55fbe74407bfad37140f
+  metadata.gz: cb882e9c7e4ebb21e3c1e083a49827617d23bc5c
+  data.tar.gz: a8ed3ec3aa408d19591842719f2c9f2fe73c7af0
 SHA512:
-  metadata.gz: b960ef54e38a0e2ca11672028d1cf6f1419c20caeac60b461890ad3e1d2155b62df48af8a68b25793dc2ff2dddad9ba61df603fbd0b20c6922fd435b2af99ad4
-  data.tar.gz: 112593760a8daeb7e2cd5bff5481acea4ff6692ce6050dd52df364237538716489b559a844a97ae803f8c71233949befd7cbb4cd20fec2a2b956fd56228aadb7
+  metadata.gz: 3a681a233949f4e990ba81a6c7fd234f29b12ea77e2c4edb76c89c07f3970b4bd89a9b91b3f9dd3d36a7147aaba3f267c42c55eb44496d14746e3036aad01bab
+  data.tar.gz: 4c89c308208b32eaa9469390e6f2688637ad3747fb9488d62368b054dd2473a571ed9f0d326e39ae98231888e983c93f5f21214de93c6238044b425f3c0ec407

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/sidekiq*.gem

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 - 2015-09-25
+
+* rake task for getting queue health report

data/README.md

@@ -53,3 +53,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/tomdev
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Credits
+
+I was inspired by Alex Stoll from HE:labs http://helabs.com/blog/2015/02/19/a-simple-way-to-monitor-sidekiq-queue-on-rails-and-sinatra/

data/lib/sidekiq/health/queue_status.rb

@@ -2,7 +2,72 @@ require 'sidekiq/api'
 
 module Sidekiq
   module Health
+    MAXIMUM_HEALTHY_QUEUE_SIZE = 50
+    MAXIMUM_HEALTHY_DEAD_SET_LAST_HOUR_SIZE = 5
+
     class QueueStatus
+      class Status
+        def initialize(queue_name, dead_set)
+          @queue_name = queue_name
+          @dead_set = dead_set
+        end
+
+        attr_reader :queue_name
+
+        def total_number_of_jobs
+          sidekiq_queue.size
+        end
+
+        def total_number_of_failed_jobs
+          dead_set.size
+        end
+
+        def total_number_of_failed_jobs_since(timestamp)
+          dead_set.select { |item| item['failed_at'] > timestamp.to_r }.size
+        end
+
+        def number_of_scheduled_jobs_per_class_name
+          @number_of_scheduled_jobs_per_class_name ||= sidekiq_queue.inject({}) do |job_pool, scheduled_job|
+            wrapped_class = scheduled_job['wrapped']
+            job_pool[wrapped_class] = job_pool.fetch(wrapped_class, 0) + 1
+            job_pool
+          end
+            .sort_by { |job_name, count| count }
+            .to_h
+        end
+
+        def health_as_human_readable_string
+          health = []
+
+          if total_number_of_jobs > Sidekiq::Health::MAXIMUM_HEALTHY_QUEUE_SIZE
+            more_than_allowed = total_number_of_jobs - Sidekiq::Health::MAXIMUM_HEALTHY_QUEUE_SIZE
+            health << "There are a total of #{total_number_of_jobs} scheduled jobs, "\
+              "which is #{more_than_allowed} more than healthy."
+          end
+
+          dead_in_last_hour = total_number_of_failed_jobs_since(1.hour.ago)
+          if dead_in_last_hour > Sidekiq::Health::MAXIMUM_HEALTHY_DEAD_SET_LAST_HOUR_SIZE
+            more_than_allowed = dead_in_last_hour - Sidekiq::Health::MAXIMUM_HEALTHY_DEAD_SET_LAST_HOUR_SIZE
+            health << "There are a total of #{dead_in_last_hour} failed jobs, "\
+              "which is #{more_than_allowed} more than healthy."
+          end
+
+          if health.empty?
+            health << "Everything looks good."
+          end
+
+          health.join(" ")
+        end
+
+        private
+
+        attr_reader :dead_set
+
+        def sidekiq_queue
+          @sidekiq_queue ||= Sidekiq::Queue.new queue_name
+        end
+      end
+
       def print
         output = ""
 
@@ -14,6 +79,14 @@ module Sidekiq
         output
       end
 
+      def statuses
+        queue_names.map do |name|
+          Status.new \
+            name,
+            dead_set_for(queue_name: name)
+        end
+      end
+
       private
 
       def queue_size(name)
@@ -23,11 +96,20 @@ module Sidekiq
       def queue_names
         Sidekiq::Health::QueueNames.new.get
       end
+
+      def dead_set_for(queue_name:)
+        all_dead_jobs.fetch(queue_name, [])
+      end
+
+      def all_dead_jobs
+        @all_dead_jobs ||= Sidekiq::DeadSet.new.inject({}) do |all_jobs, item|
+          all_jobs[item.queue] = all_jobs.fetch(item.queue, []) + [item]
+          all_jobs
+        end
+      end
     end
 
     class QueueHealthFormatter
-      QUEUE_SIZE_WARNING_THRESHOLD = 50
-
       attr_reader :name, :size
 
       def initialize(name, size)
@@ -36,13 +118,17 @@ module Sidekiq
       end
 
       def to_s
-        if size < QUEUE_SIZE_WARNING_THRESHOLD
+        if healthy?
           "OK. #{queue_information}"
         else
           "WARNING: TOO MANY JOBS ENQUEUED. #{queue_information}"
         end
       end
 
+      def healthy?
+        size < Sidekiq::Health::MAXIMUM_HEALTHY_QUEUE_SIZE
+      end
+
       private
 
       def queue_information

data/lib/sidekiq/health/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Health
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-health
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom de Vries
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Monitor the size of your Sidekiq queues.