readme: Clarify AS::Notification.subscribe arguments (#654)

* fix AS::Notification.subscribe arguments in README.md

* event_id -> instrumenter_id
This commit is contained in:
Sebastian Cohnen 2024-03-10 01:48:11 +01:00 committed by GitHub
parent 429fb7fecc
commit d7a7a8bda5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -291,7 +291,7 @@ Rack::Attack.track("special_agent", limit: 6, period: 60) do |req|
end
# Track it using ActiveSupport::Notification
ActiveSupport::Notifications.subscribe("track.rack_attack") do |name, start, finish, request_id, payload|
ActiveSupport::Notifications.subscribe("track.rack_attack") do |name, start, finish, instrumenter_id, payload|
req = payload[:request]
if req.env['rack.attack.matched'] == "special_agent"
Rails.logger.info "special_agent: #{req.path}"
@ -383,7 +383,7 @@ To get notified about specific type of events, subscribe to the event name follo
E.g. for throttles use:
```ruby
ActiveSupport::Notifications.subscribe("throttle.rack_attack") do |name, start, finish, request_id, payload|
ActiveSupport::Notifications.subscribe("throttle.rack_attack") do |name, start, finish, instrumenter_id, payload|
# request object available in payload[:request]
# Your code here
@ -393,7 +393,7 @@ end
If you want to subscribe to every `rack_attack` event, use:
```ruby
ActiveSupport::Notifications.subscribe(/rack_attack/) do |name, start, finish, request_id, payload|
ActiveSupport::Notifications.subscribe(/rack_attack/) do |name, start, finish, instrumenter_id, payload|
# request object available in payload[:request]
# Your code here