Class: ActiveSupport::Notifications::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/active_support/notifications/instrumenter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, start, ending, transaction_id, payload) ⇒ Event

Returns a new instance of Event.


58
59
60
61
62
63
64
65
66
67
68
69
# File '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

Instance Attribute Details

#childrenObject (readonly)

Returns the value of attribute children


55
56
57
# File 'lib/active_support/notifications/instrumenter.rb', line 55

def children
  @children
end

#endObject (readonly)

Returns the value of attribute end


55
56
57
# File 'lib/active_support/notifications/instrumenter.rb', line 55

def end
  @end
end

#nameObject (readonly)

Returns the value of attribute name


55
56
57
# File 'lib/active_support/notifications/instrumenter.rb', line 55

def name
  @name
end

#payloadObject

Returns the value of attribute payload


56
57
58
# File 'lib/active_support/notifications/instrumenter.rb', line 56

def payload
  @payload
end

#timeObject (readonly)

Returns the value of attribute time


55
56
57
# File 'lib/active_support/notifications/instrumenter.rb', line 55

def time
  @time
end

#transaction_idObject (readonly)

Returns the value of attribute transaction_id


55
56
57
# File 'lib/active_support/notifications/instrumenter.rb', line 55

def transaction_id
  @transaction_id
end

Instance Method Details

#<<(event) ⇒ Object


119
120
121
# File 'lib/active_support/notifications/instrumenter.rb', line 119

def <<(event)
  @children << event
end

#allocationsObject

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


99
100
101
# File 'lib/active_support/notifications/instrumenter.rb', line 99

def allocations
  @allocation_count_finish - @allocation_count_start
end

#cpu_timeObject

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


87
88
89
# File 'lib/active_support/notifications/instrumenter.rb', line 87

def cpu_time
  (@cpu_time_finish - @cpu_time_start) * 1000
end

#durationObject

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

115
116
117
# File 'lib/active_support/notifications/instrumenter.rb', line 115

def duration
  1000.0 * (self.end - time)
end

#finish!Object

Record information at the time this event finishes


79
80
81
82
83
# File 'lib/active_support/notifications/instrumenter.rb', line 79

def finish!
  @cpu_time_finish = now_cpu
  @end = now
  @allocation_count_finish = now_allocations
end

#idle_timeObject

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


93
94
95
# File 'lib/active_support/notifications/instrumenter.rb', line 93

def idle_time
  duration - cpu_time
end

#parent_of?(event) ⇒ Boolean

Returns:

  • (Boolean)

123
124
125
# File 'lib/active_support/notifications/instrumenter.rb', line 123

def parent_of?(event)
  @children.include? event
end

#start!Object

Record information at the time this event starts


72
73
74
75
76
# File 'lib/active_support/notifications/instrumenter.rb', line 72

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