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 11



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


  







Instance Attribute Details



  

    #id   (readonly)
  

  [ GitHub ]


  

  


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



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 40



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


  








  

    #finish_with_state(listeners_state, name, payload)  
  

  [ GitHub ]


  

  


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



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


  








  

    #instrument(name, payload = {})  
  



  

    

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.


  



  [ GitHub ]


  

  


# File 'activesupport/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.message]
    payload[:exception_object] = e
    raise e
  ensure
    finish_with_state listeners_state, 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 35



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