edge badge
Skip to Content Skip to Search
Methods
#
A
C
D
F
I
N
P
R
S

Attributes

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

Class Public methods

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

# File activesupport/lib/active_support/notifications/instrumenter.rb, line 62
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

Instance Public methods

<<(event)

# File activesupport/lib/active_support/notifications/instrumenter.rb, line 136
def <<(event)
  @children << event
end

allocations()

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

# File activesupport/lib/active_support/notifications/instrumenter.rb, line 116
def allocations
  @allocation_count_finish - @allocation_count_start
end

cpu_time()

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

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

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
# File activesupport/lib/active_support/notifications/instrumenter.rb, line 132
def duration
  1000.0 * (self.end - time)
end

finish!()

Record information at the time this event finishes

# File activesupport/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()

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

# File activesupport/lib/active_support/notifications/instrumenter.rb, line 110
def idle_time
  duration - cpu_time
end

parent_of?(event)

# File activesupport/lib/active_support/notifications/instrumenter.rb, line 140
def parent_of?(event)
  @children.include? event
end

record()

# File activesupport/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!()

Record information at the time this event starts

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