Docs4dev
Docs
rails / 6.1 / activesupport / notifications / event.html

class ActiveSupport::Notifications::Event

Parent:
Object

Attributes

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

Public Class Methods

new(name, start, ending, transaction_id, payload) Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 58
def initialize(name, start, ending, transaction_id, payload)
  @name           = name
  @payload        = payload.dup
  @time           = start
  @transaction_id = transaction_id
  @end            = ending
  @children       = []
  @cpu_time_start = 0
  @cpu_time_finish = 0
  @allocation_count_start = 0
  @allocation_count_finish = 0
end

Public Instance Methods

<<(event) Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 119
def <<(event)
  @children << event
end
allocations() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 99
def allocations
  @allocation_count_finish - @allocation_count_start
end

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

cpu_time() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 87
def cpu_time
  (@cpu_time_finish - @cpu_time_start) * 1000
end

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

duration() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 115
def duration
  1000.0 * (self.end - time)
end

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
finish!() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 79
def finish!
  @cpu_time_finish = now_cpu
  @end = now
  @allocation_count_finish = now_allocations
end

Record information at the time this event finishes

idle_time() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 93
def idle_time
  duration - cpu_time
end

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

parent_of?(event) Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 123
def parent_of?(event)
  @children.include? event
end
start!() Show source 
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 72
def start!
  @time = now
  @cpu_time_start = now_cpu
  @allocation_count_start = now_allocations
end

Record information at the time this event starts

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.