Class: ActiveSupport::Notifications::Instrumenter
- Defined in:
- lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb
Overview
Instrumenters are stored in a thread local.
Instance Attribute Summary collapse
-
#id ⇒ Object
readonly
Returns the value of attribute id.
Instance Method Summary collapse
-
#finish(name, payload) ⇒ Object
Send a finish notification with
name
andpayload
. - #finish_with_state(listeners_state, name, payload) ⇒ Object
-
#initialize(notifier) ⇒ Instrumenter
constructor
A new instance of Instrumenter.
-
#instrument(name, payload = {}) ⇒ Object
Given a block, instrument it by measuring the time taken to execute and publish it.
-
#new_event(name, payload = {}) ⇒ Object
:nodoc:.
-
#start(name, payload) ⇒ Object
Send a start notification with
name
andpayload
.
Constructor Details
#initialize(notifier) ⇒ Instrumenter
Returns a new instance of Instrumenter.
11 12 13 14 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 11 def initialize(notifier) @id = unique_id @notifier = notifier end |
Instance Attribute Details
#id ⇒ Object (readonly)
Returns the value of attribute id.
9 10 11 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 9 def id @id end |
Instance Method Details
#finish(name, payload) ⇒ Object
Send a finish notification with name
and payload
.
44 45 46 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 44 def finish(name, payload) @notifier.finish name, @id, payload end |
#finish_with_state(listeners_state, name, payload) ⇒ Object
48 49 50 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 48 def finish_with_state(listeners_state, name, payload) @notifier.finish name, @id, payload, listeners_state end |
#instrument(name, payload = {}) ⇒ Object
Given a block, instrument it by measuring the time taken to execute and publish it. Without a block, simply send a message via the notifier. Notice that events get sent even if an error occurs in the passed-in block.
20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 20 def instrument(name, payload = {}) # some of the listeners might have state listeners_state = start name, payload begin yield payload if block_given? rescue Exception => e payload[:exception] = [e.class.name, e.] payload[:exception_object] = e raise e ensure finish_with_state listeners_state, name, payload end end |
#new_event(name, payload = {}) ⇒ Object
:nodoc:
34 35 36 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 34 def new_event(name, payload = {}) # :nodoc: Event.new(name, nil, nil, @id, payload) end |
#start(name, payload) ⇒ Object
Send a start notification with name
and payload
.
39 40 41 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/activesupport-7.0.4/lib/active_support/notifications/instrumenter.rb', line 39 def start(name, payload) @notifier.start name, @id, payload end |