Add clear_failures method (#145)

mhfs · Oct 4, 2022 · 2b30cb1 · 2b30cb1
1 parent 0d4ba77
commit 2b30cb1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -127,13 +127,18 @@ influenced by `failures_max_count`.
 Sidekiq::Failures.count
 ```
 
-### Reset Failures
+### Reset and clear Failures
 
 Gives a convenient way of reseting Sidekiq Failure stored failed jobs programmatically.
-Takes an options hash and if the `counter` key is present also resets Sidekiq own failed stats.
 
 ```ruby
-Sidekiq::Failures.reset_failures
+Sidekiq::Failures.clear_failures
+```
+
+To reset Sidekiq own failed *stats*.
+
+```ruby
+Sidekiq::Failures.reset_failure_count
 ```
 
 ## Dependencies

diff --git a/lib/sidekiq/failures.rb b/lib/sidekiq/failures.rb
@@ -59,9 +59,19 @@ module Failures
     LIST_KEY = :failed
 
     def self.reset_failures
+      warn "NOTE: Sidekiq::Failures.reset_failures is deprecated; use Sidekiq::Failures.reset_failure_count instead."
+
+      reset_failure_count
+    end
+
+    def self.reset_failure_count
       Sidekiq.redis { |c| c.set("stat:failed", 0) }
     end
 
+    def self.clear_failures
+      FailureSet.new.clear
+    end
+
     def self.count
       Sidekiq.redis {|r| r.zcard(LIST_KEY) }
     end