Skip to Content Skip to Search
v7.1.0
class ActiveSupport::Notifications::Fanout::Handle < Object

ActiveSupport::Notifications::Fanout::Handle

A Handle is used to record the start and finish time of event.

Both start and finish must each be called exactly once.

Where possible, it’s best to use the block form: ActiveSupport::Notifications.instrument. Handle is a low-level API intended for cases where the block form can’t be used.

handle = ActiveSupport::Notifications.instrumenter.build_handle("my.event", {})
begin
  handle.start
  # work to be instrumented
ensure
  handle.finish
end
Methods
F
S

Public instance methods

finish()

Permalink
Source code GitHub
# File activesupport/lib/active_support/notifications/fanout.rb, line 247
def finish
  finish_with_values(@name, @id, @payload)
end

start()

Permalink
Source code GitHub
# File activesupport/lib/active_support/notifications/fanout.rb, line 238
def start
  ensure_state! :initialized
  @state = :started

  @groups.each do |group|
    group.start(@name, @id, @payload)
  end
end
Definition files