Methods

Attributes

[R] name
[RW] payload
[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
        @gc_time_start = 0
        @gc_time_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 176
      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 163
      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 |event|
  @event = event
end

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

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

end()

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 128
      def end
        @end / 1000.0 if @end
      end
🔎 See on GitHub

finish!()

Record information at the time this event finishes

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

gc_time()

Returns the time spent in GC (in milliseconds) between the call to start! and the call to finish!

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 182
      def gc_time
        (@gc_time_finish - @gc_time_start) / 1_000_000.0
      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 169
      def idle_time
        diff = duration - cpu_time
        diff > 0.0 ? diff : 0.0
      end
🔎 See on GitHub

start!()

Record information at the time this event starts

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

time()

📝 Source code 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 124
      def time
        @time / 1000.0 if @time
      end
🔎 See on GitHub