sidekiq-tamer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76000c7eadffdb865f4040feb9d17a98287efe2362f6005f2dbd4de14bfed92
-  data.tar.gz: 020e0c46cc617649cae0349a70fec7bca5691caf50f1b561e6c8fe6b99d45859
+  metadata.gz: 2adba0f73b751d199957c599296ec1cbcc92dae6c83129f0269aa0b4bced7ff0
+  data.tar.gz: 29db51d3795b45a596773cba3a504d7b2c9d466d1cf332b0b29e028fa76b02fa
 SHA512:
-  metadata.gz: aa908135bae11522b65f9d7f17ee638c61bd8de76065af8a991cb1e5a8862f8b306247105123ed6099518266591c4b0f51420df6f61bcfe13d0ba9b9365bcb2d
-  data.tar.gz: da3de8d73ebf24e1fed060d290b600f9e18ac797df194a2238d1def54fc085d239ec4306cc2a2a0c83616f6fcc88f40d9b9270722c90dd45025cb88d8f3276af
+  metadata.gz: 3d2c99801c6cc9c8bf3bd56419c3ce5cc6c55c56f79ef6097afd78c6ce83fcb61ed21c29eef1d33b2fd008975e98437750076606ec5fed47a1826c731599691f
+  data.tar.gz: c07175327b97edb15f1a39dbaa65eba048d9887769e26b282efc0dbbcf09f54b76fc044e97d42e8f2cd761ee7f084def477e92fc992018fb1b4558090f8712a8

data/.gitignore

@@ -11,4 +11,5 @@
 .rspec_status
 .ruby_version
 sidekiq-tamer-*.gem
-TODO.txt
+TODO.txt
+.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-tamer (0.2.0)
+    sidekiq-tamer (0.2.1)
       mongo (>= 2.0.0, < 3.0.0)
       sidekiq (>= 5.0.0, < 7.0.0)
 

data/README.md

@@ -1,8 +1,8 @@
-# Sidekiq Tamer
-Do you ever worry about your Sidekiq jobs consuming too many resources, causing your system to slow down or even crash? When you don't have specific throttling requirements, Sidekiq Tamer can help you to easily protect your resources and prevent them from being overwhelmed by Sidekiq overscaling.
+# SidekiqTamer
+Do you ever worry about your Sidekiq jobs consuming too many resources, causing your system to slow down or even crash? When you don't have specific throttling requirements, SidekiqTamer can help you to easily protect your resources and prevent them from being overwhelmed by Sidekiq overscaling.
 
 ## Installation
-Getting started with Sidekiq Tamer is a breeze. Simply add the gem to your Gemfile:
+Getting started with SidekiqTamer is a breeze. Simply add the gem to your Gemfile:
 
 ```ruby
 gem 'sidekiq-tamer'
@@ -11,14 +11,17 @@ gem 'sidekiq-tamer'
 Then, run bundle install or gem install sidekiq-tamer to install the gem.
 
 ## Usage
-With Sidekiq Tamer, you can delay the execution of jobs that depend on particular resources when those are on an stressed state. While Sidekiq Tamer was initially built to help handling the load over MongoDB, its actually a generic framework which you can use to protect any kind of resource, such as a database or an API endpoint.
+With SidekiqTamer, you can delay the execution of jobs that depend on particular resources when those are on an stressed state. While SidekiqTamer was initially built to help handling the load over MongoDB, it is actually a generic framework which you can use to protect any kind of resource, such as a database or an API endpoint.
 
 ### Protecting a MongoDB cluster
-Sidekiq Tamer includes an off-the-shelf implementation to handle MongoDB clusters. To use it, simply execute the following line during your initialization code:
+SidekiqTamer includes an off-the-shelf implementation to handle MongoDB clusters. To use it, simply execute the following line during your initialization code:
 
 ```ruby
 SidekiqTamer::Mongo::Configuration.setup(user: 'your_user', password: 'your_password')
 ```
+
+The MongoDB monitoring relies on inspecting the read and write available tickets and whenever those are below a certain configurable threshold, the server is assumed to be on an unhealthy state and therefore jobs will be pushed back until health is recovered.
+
 Note that in order for the health monitor to work, you'll need to supply a user that has the clusterMonitor role enabled on the admin database of your cluster.
 
 ### Defining Your Own Resources
@@ -46,10 +49,10 @@ Then, add an instance of your new class to the resource vault:
 SidekiqTamer::Resource::Vault.add_resources(MyDatabaseResource.new)
 ```
 
-Now, whenever the `is_healthy?` method returns false for a job that depends on this resource, the Sidekiq middleware that Sidekiq Tamer introduces will raise an exception, causing the job to be retried later.
+Now, whenever the `is_healthy?` method returns false for a job that depends on this resource, the Sidekiq middleware that SidekiqTamer introduces will raise an exception, causing the job to be retried later.
 
 ## Contributing
 We welcome bug reports and pull requests on GitHub at https://github.com/leandrogoe/sidekiq-tamer.
 
 ## License
-Sidekiq Tamer is available as open source under the terms of the MIT License.
+SidekiqTamer is available as open source under the terms of the MIT License.

data/lib/sidekiq_tamer/version.rb

@@ -1,3 +1,3 @@
 module SidekiqTamer
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-tamer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Leandro Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq