Class: ActiveSupport::Notifications::Instrumenter

Inherits:
Object
  • Object
show all
Defined in:
activesupport/lib/active_support/notifications/instrumenter.rb

Overview

Instrumenters are stored in a thread local.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(notifier) ⇒ Instrumenter

Returns a new instance of Instrumenter.


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

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

Instance Attribute Details

#idObject (readonly)

Returns the value of attribute id


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

def id
  @id
end

Instance Method Details

#finish(name, payload) ⇒ Object

Send a finish notification with name and payload.


37
38
39
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 37

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

#finish_with_state(listeners_state, name, payload) ⇒ Object


41
42
43
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 41

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

#instrument(name, payload = {}) ⇒ Object

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.


17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 17

def instrument(name, payload={})
  # some of the listeners might have state
  listeners_state = start name, payload
  begin
    yield payload
  rescue Exception => e
    payload[:exception] = [e.class.name, e.message]
    payload[:exception_object] = e
    raise e
  ensure
    finish_with_state listeners_state, name, payload
  end
end

#start(name, payload) ⇒ Object

Send a start notification with name and payload.


32
33
34
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 32

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