Instrumenters are stored in a thread local.

Methods

Attributes

[R] id

Class Public methods

new(notifier)

📝 Source code
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 11
      def initialize(notifier)
        @id       = unique_id
        @notifier = notifier
      end
🔎 See on GitHub

Instance Public methods

finish(name, payload)

Send a finish notification with name and payload.

📝 Source code
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 40
      def finish(name, payload)
        @notifier.finish name, @id, payload
      end
🔎 See on GitHub

finish_with_state(listeners_state, name, payload)

📝 Source code
# 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
🔎 See on GitHub

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.

📝 Source code
# 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
🔎 See on GitHub

start(name, payload)

Send a start notification with name and payload.

📝 Source code
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 35
      def start(name, payload)
        @notifier.start name, @id, payload
      end
🔎 See on GitHub