class ActiveSupport::Notifications::Event

Attributes

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

Public Class Methods

new(name, start, ending, transaction_id, payload) click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 62
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
  @children       = []
  @cpu_time_start = 0.0
  @cpu_time_finish = 0.0
  @allocation_count_start = 0
  @allocation_count_finish = 0
end

Public Instance Methods

<<(event) click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 136
def <<(event)
  @children << event
end
allocations() click to toggle source

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

# File lib/active_support/notifications/instrumenter.rb, line 116
def allocations
  @allocation_count_finish - @allocation_count_start
end
cpu_time() click to toggle source

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

# File lib/active_support/notifications/instrumenter.rb, line 104
def cpu_time
  @cpu_time_finish - @cpu_time_start
end
duration() click to toggle source

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
# File lib/active_support/notifications/instrumenter.rb, line 132
def duration
  self.end - time
end
finish!() click to toggle source

Record information at the time this event finishes

# File lib/active_support/notifications/instrumenter.rb, line 96
def finish!
  @cpu_time_finish = now_cpu
  @end = now
  @allocation_count_finish = now_allocations
end
idle_time() click to toggle source

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

# File lib/active_support/notifications/instrumenter.rb, line 110
def idle_time
  duration - cpu_time
end
parent_of?(event) click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 140
def parent_of?(event)
  @children.include? event
end
record() { |payload| ... } click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 75
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
start!() click to toggle source

Record information at the time this event starts

# File lib/active_support/notifications/instrumenter.rb, line 89
def start!
  @time = now
  @cpu_time_start = now_cpu
  @allocation_count_start = now_allocations
end

Private Instance Methods

now() click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 145
def now
  Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
end
now_allocations() click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 162
def now_allocations
  GC.stat(:total_allocated_objects)
end
now_cpu() click to toggle source
# File lib/active_support/notifications/instrumenter.rb, line 152
def now_cpu
  Process.clock_gettime(Process::CLOCK_THREAD_CPUTIME_ID, :float_millisecond)
end