123456789_123456789_123456789_123456789_123456789_

Class: ActiveSupport::Notifications::Instrumenter

Relationships & Source Files
Inherits: Object
Defined in: activesupport/lib/active_support/notifications/instrumenter.rb

Overview

Instrumenters are stored in a thread local.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(notifier) ⇒ Instrumenter

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 9

def initialize(notifier)
  @id       = unique_id
  @notifier = notifier
end

Instance Attribute Details

#id (readonly)

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 7

attr_reader :id

Instance Method Details

#finish(name, payload)

Send a finish notification with name and payload.

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 35

def finish(name, payload)
  @notifier.finish name, @id, payload
end

#instrument(name, payload = {})

Instrument the given block by measuring the time taken to execute it and publish it. Notice that events get sent even if an error occurs in the passed-in block.

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 17

def instrument(name, payload={})
  start name, payload
  begin
    yield payload
  rescue Exception => e
    payload[:exception] = [e.class.name, e.message]
    raise e
  ensure
    finish name, payload
  end
end

#start(name, payload)

Send a start notification with name and payload.

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 30

def start(name, payload)
  @notifier.start name, @id, payload
end