Methods

Attributes

[R] end
[R] name
[RW] payload
[R] time
[R] transaction_id

Class Public methods

new(name, start, ending, transaction_id, payload)

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 110
      def initialize(name, start, ending, transaction_id, payload)
        @name           = name
        @payload        = payload.dup
        @time           = start ? start.to_f * 1_000.0 : start
        @transaction_id = transaction_id
        @end            = ending ? ending.to_f * 1_000.0 : ending
        @cpu_time_start = 0.0
        @cpu_time_finish = 0.0
        @allocation_count_start = 0
        @allocation_count_finish = 0
      end
🔎 See on GitHub

Instance Public methods

allocations()

Returns the number of allocations made between the call to start! and the call to finish!.

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 164
      def allocations
        @allocation_count_finish - @allocation_count_start
      end
🔎 See on GitHub

cpu_time()

Returns the CPU time (in milliseconds) passed between the call to start! and the call to finish!.

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 151
      def cpu_time
        @cpu_time_finish - @cpu_time_start
      end
🔎 See on GitHub

duration()

Returns the difference in milliseconds between when the execution of the event started and when it ended.

ActiveSupport::Notifications.subscribe('wait') do |*args|
  @event = ActiveSupport::Notifications::Event.new(*args)
end

ActiveSupport::Notifications.instrument('wait') do
  sleep 1
end

@event.duration # => 1000.138
📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 197
      def duration
        self.end - time
      end
🔎 See on GitHub

finish!()

Record information at the time this event finishes

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 143
      def finish!
        @cpu_time_finish = now_cpu
        @end = now
        @allocation_count_finish = now_allocations
      end
🔎 See on GitHub

idle_time()

Returns the idle time time (in milliseconds) passed between the call to start! and the call to finish!.

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 157
      def idle_time
        diff = duration - cpu_time
        diff > 0.0 ? diff : 0.0
      end
🔎 See on GitHub

record()

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 122
      def record
        start!
        begin
          yield payload if block_given?
        rescue Exception => e
          payload[:exception] = [e.class.name, e.message]
          payload[:exception_object] = e
          raise e
        ensure
          finish!
        end
      end
🔎 See on GitHub

start!()

Record information at the time this event starts

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 136
      def start!
        @time = now
        @cpu_time_start = now_cpu
        @allocation_count_start = now_allocations
      end
🔎 See on GitHub