sidekiq_status_monitor 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff542b7575a5a9d3056126393cda3f7e8b8488f237fcc620bb8d4786f9b45b6
-  data.tar.gz: 1117ed0ee145457b1ab9931a9610702532612e12142aa9881fc25cafc3649287
+  metadata.gz: c41f2c9bc2ce7b5a377d49921da85454fe34f550caef7ee37c7d9c3a739fde3c
+  data.tar.gz: c319d55e81e666d2f3acfd6a36dda321a8803e729b8cfd83d957dfbf0f8d5292
 SHA512:
-  metadata.gz: ab1cd10cfa90f87275e1b13794c57369d99394d3fe3bca58163c98af5c92c2315b0d12ac4e20eff2a406a20e27be7457e04813232fcf2dc9d6ecc8dd38b3bccd
-  data.tar.gz: 3a1a817db8c0142ecb061fe442501d72e0b90e870852c72cf933070b1d5aea5ed1c904c999d4f57e0a77497b95cc6418b276566fdef002316661079b84d8c177
+  metadata.gz: b3f2758a49ba295e005dd5dd40ceba28ca7ac9c359d97edf3868ded252c6fe8326d81c5cc440f42a341c6e8cc25e0b2f09539937a0de64a607aff8cabd74f820
+  data.tar.gz: 6203778281a478136f3eb73835e5736ff43e7d6b9f1d03139d804a5aa5fc6e850df386f64c0d7358733d8f24e0a94ec5afef1ba09d059ab3e51c7c81e036a881

data/README.md

@@ -10,32 +10,9 @@ This library can be used to check sidekiq health outside kubernetes.
 
 **How?**
 
-A http server is started and on each requests validates that a liveness key is stored in Redis. If it is there means is working.
+An additional HTTP server is started during Sidekiq worker initialisation and on each request validates that the Sidekiq worker metrics look healthy.
 
-A Sidekiq worker is the responsible to storing this key. If Sidekiq stops processing workers
-this key gets expired by Redis an consequently the http server will return a 500 error.
-
-This worker is responsible to requeue itself for the next liveness probe.
-
-Each instance in kubernetes will be checked based on `ENV` variable `HOSTNAME` (kubernetes sets this for each replica/pod).
-
-On initialization SidekiqStatusMonitor will asign to Sidekiq::Worker a queue with the current host and add this queue to the current instance queues to process.
-
-example:
-
-```
-hostname: foo
-  Worker queue: sidekiq_status_monitor-foo
-  instance queues:
-   - sidekiq_status_monitor-foo
-   *- your queues
-
-hostname: bar
-  Worker queue: sidekiq_status_monitor-bar
-  instance queues:
-   - sidekiq_status_monitor-bar
-   *- your queues
-```
+It reports either 200 or 500 HTTP code with additional JSON payload which includes metrics values.
 
 ## Installation
 

data/lib/sidekiq_status_monitor/config.rb

@@ -5,16 +5,16 @@ module SidekiqStatusMonitor
     include Singleton
 
     attr_accessor :host,
-                  :port,
-                  :path,
-                  :server,
-                  :logger,
-                  :shutdown_callback,
-                  :workers_size_threshold,
-                  :process_set_size_threshold,
-                  :queues_size_threshold,
-                  :queue_latency_threshold,
-                  :queue_size_threshold
+      :port,
+      :path,
+      :server,
+      :logger,
+      :shutdown_callback,
+      :workers_size_threshold,
+      :process_set_size_threshold,
+      :queues_size_threshold,
+      :queue_latency_threshold,
+      :queue_size_threshold
 
     def initialize
       set_defaults

data/lib/sidekiq_status_monitor/redis/redis_client_gem.rb

@@ -43,9 +43,9 @@ module SidekiqStatusMonitor
 
       private
 
-      def redis(&block)
+      def redis(&)
         # Default to Sidekiq.redis if capsule is not configured yet but redis adapter is accessed
-        (@capsule || Sidekiq).redis(&block)
+        (@capsule || Sidekiq).redis(&)
       end
     end
   end

data/lib/sidekiq_status_monitor/redis/redis_gem.rb

@@ -37,8 +37,8 @@ module SidekiqStatusMonitor
 
       private
 
-      def redis(&block)
-        Sidekiq.redis(&block)
+      def redis(&)
+        Sidekiq.redis(&)
       end
     end
   end

data/lib/sidekiq_status_monitor/server.rb

@@ -36,7 +36,7 @@ module SidekiqStatusMonitor
     def call(_env)
       [
         alive? ? 200 : 500,
-        { "Content-Type" => "application/json" },
+        {"Content-Type" => "application/json"},
         [payload.to_json]
       ]
     end

data/lib/sidekiq_status_monitor/version.rb

@@ -1,3 +1,3 @@
 module SidekiqStatusMonitor
-  VERSION = '1.0.0'
+  VERSION = "1.2.0"
 end

data/lib/sidekiq_status_monitor.rb

@@ -101,8 +101,8 @@ module SidekiqStatusMonitor
       queues.map(&:name).uniq.sort
     end
 
-    def self.new_probe(name, &block)
-      define_method("#{PROBE_METHOD_PREFIX}#{name}", &block)
+    def self.new_probe(name, &)
+      define_method(:"#{PROBE_METHOD_PREFIX}#{name}", &)
     end
 
     new_probe :workers_size do
@@ -126,7 +126,7 @@ module SidekiqStatusMonitor
     end
 
     def probes
-      methods.grep(/^#{PROBE_METHOD_PREFIX}/).map { |m| [m, send(m)] }.to_h
+      methods.grep(/^#{PROBE_METHOD_PREFIX}/o).map { |m| [m, send(m)] }.to_h
     end
 
     def alive?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_status_monitor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrei Makarov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,47 +95,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-shopify
+  name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: standard-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
+        version: '1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: standard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +220,7 @@ metadata:
   homepage_uri: https://github.com/amkisko/sidekiq_status_monitor
   source_code_uri: https://github.com/amkisko/sidekiq_status_monitor
   changelog_uri: https://github.com/amkisko/sidekiq_status_monitor/releases
-  documentation_uri: https://github.com/amkisko/sidekiq_status_monitor/blob/v1.0.0/README.md
+  documentation_uri: https://github.com/amkisko/sidekiq_status_monitor/blob/v1.2.0/README.md
   bug_tracker_uri: https://github.com/amkisko/sidekiq_status_monitor/issues
 post_install_message:
 rdoc_options: []
@@ -223,8 +237,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Sidekiq status web server extension.
+summary: Rack server that outputs HTTP JSON status of sidekiq instance for alive/liveness
+  checks and monitoring.
 test_files: []