forked from rails/exception_notification
-
Notifications
You must be signed in to change notification settings - Fork 415
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds a throttle notifier to throttle any notifier #224
Open
matstc
wants to merge
1
commit into
smartinez87:master
Choose a base branch
from
matstc:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
module ExceptionNotifier | ||
class ThrottleNotifier | ||
def initialize options={} | ||
@notifier = ExceptionNotifier.create_notifier(options[:notifier], options[:notifier_options] || {}) | ||
@max_notifications_per_hour = 3 | ||
@past_exceptions = Hash.new {|h,k| h[k] = []} | ||
end | ||
|
||
def call(exception, options={}) | ||
key = exception.class.to_s.each_byte.reduce(&:+) | ||
|
||
past_times = @past_exceptions[key] | ||
past_times.reject! {|t| (Time.now - t) >= 3600} | ||
past_times << Time.now | ||
|
||
if past_times.size <= @max_notifications_per_hour | ||
@notifier.call exception, options | ||
else | ||
ExceptionNotifier::logger.warn "An exception occurred (#{exception}) and the notifier #{@notifier} was throttled." | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
require 'test_helper' | ||
|
||
class ThrottleNotifierTest < ActiveSupport::TestCase | ||
setup do | ||
@throttle = ExceptionNotifier::ThrottleNotifier.new notifier: :email | ||
@notifier = @throttle.instance_variable_get "@notifier" | ||
end | ||
|
||
test "should delegate to notifier by default" do | ||
exception = Exception.new | ||
options = {} | ||
@notifier.expects(:call).with(exception, options) | ||
|
||
@throttle.call exception, options | ||
end | ||
|
||
test "should stop delegating after three equivalent exceptions occur" do | ||
exception = Exception.new | ||
options = {} | ||
@notifier.expects(:call).with(exception, options).times(3) | ||
ExceptionNotifier::logger.expects(:warn).stubs(:warn) | ||
|
||
4.times { @throttle.call exception, options } | ||
end | ||
|
||
test "should resume delegating after an hour has passed" do | ||
Time.stubs(:now).returns(Time.new 2000,1,1,1) | ||
exception = Exception.new | ||
options = {} | ||
@notifier.stubs(:call) | ||
ExceptionNotifier::logger.expects(:warn).times(2).stubs(:warn) | ||
|
||
4.times { @throttle.call exception, options } | ||
|
||
Time.stubs(:now).returns(Time.new 2000,1,1,2) | ||
@notifier.expects(:call).with(exception, options).times(3) | ||
|
||
4.times { @throttle.call exception, options } | ||
end | ||
end | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let pass max_notifications_per_hour as a configuration option!