sidekiq_queue_status 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32426fcdf33231d81705398d85a9202f7a172f6a
-  data.tar.gz: 30bd276ea5ece5a0abfbb330285527d407db13c0
+  metadata.gz: cc5fd855d926709a368cc99a1da6e19b2e7979f9
+  data.tar.gz: da788b27a27e1fd9572dfe06cdb50a99aa08329f
 SHA512:
-  metadata.gz: d4fc67ee170af880100f568e93cbf84f5a2d29a28854495bcaad7ada6295db37f4115275d21ae5b9910d868ec351cd3faea3312b1bfd7b693cf45fa079ffb2a0
-  data.tar.gz: 2d3b2e1e5011dfa927a1d32d99df7f7ed4c7908a2ea7586a4a1e18911e44812d5b6ebc2ff294fa10257877b64dd39e1e0eca2ca275034ee767f57bbf3d85c136
+  metadata.gz: f6f4775f9183af9637b917b8f0fe843473f40af3a6d1b43edecf60858c25ea4f961973b9b76b60d070cce45e94c560637de945d4d17642b88cfc98e69b57dbbc
+  data.tar.gz: c9244adf2de5e48c57da03f6bf5d75a4436e352681068edd9f3c4ef76a11df557b5f32f23535460b93398bd35b244a4ced098d0e40dcbf5196e567bf4ff8d588

data/README.md

@@ -7,11 +7,21 @@ Lists latency for each sidekiq queue. The latency is the number of
 seconds the oldest job (next in line) is waiting to be performed.
 
 Under normal circumstances returns a `200 OK` status code. When latency
-is higher than the 30s default threshold, a `503 Service Unavailable` is
-returned.
+is higher than the 30s default threshold, or when the failure rate
+on the current day is higher than 10%, a `503 Service Unavailable`
+is returned.
 
 Thresholds are configurable by setting `config.queue_tresholds` hash.
 Key is queue name, value is latency threshold in seconds.
+Set `config.queue_failure_rate` to override the default failure rate.
+
+```ruby
+# config/application.rb
+Application.configure do
+  config.queue_tresholds['batch'] = 10.minutes
+  config.queue_failure_rate = 5
+end
+```
 
 Response body is a JSON object, listing the latencies of all queues and
 an array of error messages explaining which queues triggered a threshold
@@ -21,9 +31,10 @@ error.
 {
   "latencies": {
     "batch": 200,
-    "default": 1
+    "default": 1,
+    "failure_percentage": 25
   },
-  "errors": ["Queue batch above threshold of 100"]
+  "errors": ["Queue batch above threshold of 100", "Failure rate above 5%"]
 }
 ```
 

data/lib/sidekiq_queue_status/middleware.rb

@@ -3,14 +3,16 @@ require 'sidekiq/api'
 module SidekiqQueueStatus
   class Middleware
     DEFAULT_TRESHOLD = 30
+    DEFAULT_FAILURE_RATE_PERC = 10
     HEADERS = {
       'Content-Type' => 'application/json',
       'Cache-Control' => 'no-cache'
     }
 
-    def initialize(app, configured_tresholds)
+    def initialize(app, configured_tresholds, failure_rate)
       @app = app
       @latency_treshold = Hash.new(DEFAULT_TRESHOLD).merge(configured_tresholds)
+      @max_failure_rate = failure_rate || DEFAULT_FAILURE_RATE_PERC
     end
 
     def call(env)
@@ -20,7 +22,9 @@ module SidekiqQueueStatus
           max_latency = @latency_treshold[name]
           errors << "Queue #{name} above threshold of #{max_latency}s" if latency > max_latency
         end
-        body = { latencies: queues, errors: errors }.to_json
+        failure_rate = calculate_failure_rate
+        errors << "Failure rate above #{@max_failure_rate}%" if failure_rate > @max_failure_rate
+        body = { latencies: queues, failure_percentage: failure_rate, errors: errors }.to_json
         status = errors.any? ? 503 : 200
         [status, HEADERS, [body]]
       else
@@ -31,5 +35,12 @@ module SidekiqQueueStatus
     def queues
       Sidekiq::Queue.all.map { |q| [q.name, q.latency.to_i] }.to_h
     end
+
+    def calculate_failure_rate
+      stats = Sidekiq::Stats::History.new(1)
+      processed, failed = [stats.processed, stats.failed].map { |h| h.values.last }
+      val = (failed.to_f / processed.to_f) * 100.0
+      val > 0 ? val.to_i : 0
+    end
   end
 end

data/lib/sidekiq_queue_status/railtie.rb

@@ -3,8 +3,9 @@ require 'rails/railtie'
 module SidekiqQueueStatus
   class Railtie < Rails::Railtie
     config.queue_tresholds = {}
+    config.queue_failure_rate = nil
     initializer "sidekiq_queue_status.configure_rails_initialization" do |app|
-      app.middleware.use SidekiqQueueStatus::Middleware, app.config.queue_tresholds
+      app.middleware.use SidekiqQueueStatus::Middleware, app.config.queue_tresholds, app.config.queue_failure_rate
     end
   end
 end

data/lib/sidekiq_queue_status/version.rb

@@ -1,3 +1,3 @@
 module SidekiqQueueStatus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_queue_status
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthijs Langenberg