123456789_123456789_123456789_123456789_123456789_

Class: ActiveSupport::Notifications::Event

Relationships & Source Files
Inherits: Object
Defined in: activesupport/lib/active_support/notifications/instrumenter.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, start, ending, transaction_id, payload) ⇒ Event

[ GitHub ]

  
# 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

Instance Attribute Details

#name (readonly)

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 107

attr_reader :name, :transaction_id

#payload (rw)

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 108

attr_accessor :payload

#transaction_id (readonly)

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 107

attr_reader :name, :transaction_id

Instance Method Details

#allocations

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 172

def allocations
  @allocation_count_finish - @allocation_count_start
end

#cpu_time

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

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 159

def cpu_time
  @cpu_time_finish - @cpu_time_start
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
[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 205

def duration
  @end - @time
end

#end

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 126

def end
  @end / 1000.0 if @end
end

#finish!

Record information at the time this event finishes

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 151

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 between the call to #start! and the call to #finish!.

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 165

def idle_time
  diff = duration - cpu_time
  diff > 0.0 ? diff : 0.0
end

#start!

Record information at the time this event starts

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 144

def start!
  @time = now
  @cpu_time_start = now_cpu
  @allocation_count_start = now_allocations
end

#time

[ GitHub ]

  
# File 'activesupport/lib/active_support/notifications/instrumenter.rb', line 122

def time
  @time / 1000.0 if @time
end