sidekiq-monitoring 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b415451ae88923236fa1ec3b2371e5a14c9510d6
-  data.tar.gz: 317a56005f5d0366cc8c2757d87a6bd82bf01b98
+  metadata.gz: ff9875b4a8c594e350b7fa0011370e3e6f2b85f5
+  data.tar.gz: 26b491d59ff14b95e8cc7d990bc3708cfc96c445
 SHA512:
-  metadata.gz: df938fb0ed1ec27f90029ea5feccb36bc7d95b2441b79efe147256095abce6bc3accf66490abbbe7785ba79b2518aad278ec87ac70e87fb4fb25069cfe60a6e8
-  data.tar.gz: 65251acce94105c8110ea045f5694797a985a40c8e3d70e1ef8dc9bb23b08c14295badb5b3310247c2cf83af021d16759cfb6b9045b5934829a6fba13b74d90c
+  metadata.gz: 4d8dd80f523151bc5dad5c48a2316e4cb70e8523dcc91ffbc9e55607af70792af081bc36afdf136c327ca49ab176a9b4e46e8103fd9757e326e025bc95801943
+  data.tar.gz: 63003606a81842ec0d2e8d6780f387dd3cfc0cc6a75901888721d8a2d8eb859fd4b709bf7db4f9afaa7fe3bb180cd3a7ee411a391643ddf315b283469e60c2c4

data/README.md

@@ -28,6 +28,12 @@ SidekiqMonitoring.thresholds = {
   'queue_name_2' => [warning, critical],
   'queue_name_3' => [warning, critical]
 }
+
+SidekiqMonitoring.latency_thresholds = {
+  'queue_name_1' => [warning, critical],
+  'queue_name_2' => [warning, critical],
+  'queue_name_3' => [warning, critical]
+}
 ```
 
 Or if you want to override the default threshold in case of the queue name

data/VERSION

@@ -1 +1 @@
-0.5.2
+1.0.0

data/lib/sidekiq-monitoring.rb

@@ -3,20 +3,24 @@ require 'multi_json'
 
 class SidekiqMonitoring < Sinatra::Base
 
-  # Set yours down thresholds configuration
+  # Set your down thresholds configuration
   # {'default' => [ 1_000, 2_000 ], 'low' => [ 10_000, 20_000 ] }
   def self.thresholds=(thresholds)
     @@thresholds = thresholds
   end
   @@thresholds = {}
 
+  def self.latency_thresholds=(latency_thresholds)
+    @@latency_thresholds = latency_thresholds
+  end
+  @@latency_thresholds = {}
+
   get '/sidekiq_queues' do
     content_type :json
     MultiJson.dump SidekiqMonitoring::Global.new(@@thresholds)
   end
 
-  class Queue
-
+  module Monitorable
     ALERT_STATUS = {
       'OK' => 0,
       'WARNING' => 1,
@@ -24,34 +28,83 @@ class SidekiqMonitoring < Sinatra::Base
       'UNKNOWN' => 3
     }
 
-    DEFAULT_THRESHOLD = [ 1_000, 2_000 ]
+    attr_accessor :warning_threshold, :critical_threshold, :status
+
+    def <=>(other)
+      ALERT_STATUS[status] <=> ALERT_STATUS[other.status]
+    end
 
-    attr_accessor :name, :size, :warning_threshold, :critical_threshold, :status
+  end
 
-    def as_json(options = {})
+  class Worker
+    include Monitorable
+
+    DEFAULT_THRESHOLD = [ 60, 120 ]
+
+    attr_accessor :process_id, :jid, :run_at, :queue, :worker_class
+
+    def initialize(process_id, jid, run_at, queue, worker_class, thresholds = nil)
+      @process_id = process_id
+      @jid = jid
+      @run_at = run_at
+      @queue = queue
+      @worker_class = worker_class
+      @warning_threshold, @critical_threshold = thresholds ? thresholds : DEFAULT_THRESHOLD
+    end
+
+    def as_json
       {
-        'name' => name,
-        'size' => size,
-        'warning_threshold' => warning_threshold,
-        'critical_threshold' => critical_threshold,
-        'status' => status
+        'queue' => queue,
+        'jid' => jid,
+        'worker_class' => worker_class,
+        'elapsed_time' => elapsed_time,
+        'status' => status,
+        'process_id' => process_id
       }
     end
 
-    def initialize(name, size, thresholds = nil)
+    def elapsed_time
+      @elapsed_time ||= Time.now.to_i - run_at
+    end
+
+    def status
+      return 'CRITICAL' if elapsed_time >= critical_threshold
+      return 'WARNING' if elapsed_time >= warning_threshold
+      'OK'
+    end
+
+  end
+
+  class Queue
+    include Monitorable
+
+    DEFAULT_THRESHOLD = [ 1_000, 2_000 ]
+    DEFAULT_LATENCY_THRESHOLD = [ 300, 900 ]
+
+    attr_accessor :name, :size, :latency, :warning_latency_threshold, :critical_latency_threshold
+
+    def initialize(name, size, latency, thresholds = nil, latency_thresholds = nil)
       @name = name
       @size = size
+      @latency = latency
       @warning_threshold, @critical_threshold = (thresholds ? thresholds : DEFAULT_THRESHOLD)
+      @warning_latency_threshold, @critical_latency_threshold = (latency_thresholds ? latency_thresholds : DEFAULT_LATENCY_THRESHOLD)
       @status = monitoring_status
     end
 
-    def <=>(other)
-      ALERT_STATUS[status] <=> ALERT_STATUS[other.status]
+    def as_json
+      {
+        'name' => name,
+        'size' => size,
+        'warning_threshold' => warning_threshold,
+        'critical_threshold' => critical_threshold,
+        'status' => status
+      }
     end
 
     def monitoring_status
-      return 'CRITICAL' if size >= critical_threshold
-      return 'WARNING' if size >= warning_threshold
+      return 'CRITICAL' if size >= critical_threshold || latency >= critical_latency_threshold
+      return 'WARNING' if size >= warning_threshold || latency >= warning_latency_threshold
       'OK'
     end
 
@@ -59,33 +112,53 @@ class SidekiqMonitoring < Sinatra::Base
 
   class Global
 
-    attr_accessor :thresholds
+    attr_accessor :thresholds, :latency_thresholds
 
     def as_json(options = {})
       {
         'global_status' => global_status,
-        'queues' => queues.map(&:as_json)
+        'queues' => queues.map(&:as_json),
+        'workers' => workers.map(&:as_json)
       }
     end
 
     def global_status
-      @global_status ||= (queues.sort.last && queues.sort.last.status) || 'UNKNOWN'
+      queue_status = (queues.sort.last && queues.sort.last.status) || 'UNKNOWN'
+      worker_status = (workers.sort.last && workers.sort.last.status) || 'UNKNOWN'
+      status = if worker_status != 'UNKNOWN' && Monitorable::ALERT_STATUS[worker_status] > Monitorable::ALERT_STATUS[queue_status]
+        worker_status
+      else
+        queue_status
+      end
+      @global_status ||= status
     end
 
-    def initialize(thresholds = {})
+    def initialize(thresholds = {}, latency_thresholds = {})
       @thresholds = thresholds
+      @latency_thresholds = latency_thresholds
     end
 
     def queues
-      @queues ||= Sidekiq::Queue.all.collect{ |queue|
-        Queue.new(queue.name, queue.size, thresholds_from_queue(queue.name))
-      }
+      @queues ||= Sidekiq::Queue.all.map do |queue|
+        Queue.new(queue.name, queue.size, queue.latency, thresholds_from_queue(queue.name), latency_thresholds_from_queue(queue.name))
+      end
+    end
+
+    def workers
+      @workers ||= Sidekiq::Workers.new.map do |process_id, thread_id, work|
+        payload = work['payload']
+        Worker.new(process_id, payload['jid'], work['run_at'], work['queue'], payload['class'], latency_thresholds_from_queue(work['queue']))
+      end
     end
 
     def thresholds_from_queue(queue_name)
       (thresholds || {})[queue_name]
     end
 
+    def latency_thresholds_from_queue(queue_name)
+      (latency_thresholds || {})[queue_name]
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-monitoring
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
-- Jérémy Carlier
+- Jeremy Carlier
 autorequire: 
 bindir: ''
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -90,7 +90,8 @@ files:
 - VERSION
 - lib/sidekiq-monitoring.rb
 homepage: http://github.com/dimelo/sidekiq-monitoring
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Addons to provide a monitoring API for Sidekiq