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.



62
63
64
65
66
67
68
69
70
71
72
73
 
# 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

Instance Attribute Details

#children ⇒ Object (readonly)

Returns the value of attribute children.



59
60
61
 
# File 'lib/active_support/notifications/instrumenter.rb', line 59

def children
  @children
end

#end ⇒ Object (readonly)

Returns the value of attribute end.



59
60
61
 
# File 'lib/active_support/notifications/instrumenter.rb', line 59

def end
  @end
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



59
60
61
 
# File 'lib/active_support/notifications/instrumenter.rb', line 59

def name
  @name
end

#payload ⇒ Object

Returns the value of attribute payload.



60
61
62
 
# File 'lib/active_support/notifications/instrumenter.rb', line 60

def payload
  @payload
end

#time ⇒ Object (readonly)

Returns the value of attribute time.



59
60
61
 
# File 'lib/active_support/notifications/instrumenter.rb', line 59

def time
  @time
end

#transaction_id ⇒ Object (readonly)

Returns the value of attribute transaction_id.



59
60
61
 
# File 'lib/active_support/notifications/instrumenter.rb', line 59

def transaction_id
  @transaction_id
end

Instance Method Details

#<<(event) ⇒ Object 



136
137
138
 
# File 'lib/active_support/notifications/instrumenter.rb', line 136

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

#allocations ⇒ Object

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



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

def allocations
  @allocation_count_finish - @allocation_count_start
end

#cpu_time ⇒ Object

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



104
105
106
 
# File 'lib/active_support/notifications/instrumenter.rb', line 104

def cpu_time
  @cpu_time_finish - @cpu_time_start
end

#duration ⇒ Object

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



132
133
134
 
# File 'lib/active_support/notifications/instrumenter.rb', line 132

def duration
  self.end - time
end

#finish! ⇒ Object

Record information at the time this event finishes



96
97
98
99
100
 
# 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 ⇒ Object

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



110
111
112
 
# File 'lib/active_support/notifications/instrumenter.rb', line 110

def idle_time
  duration - cpu_time
end

#parent_of?(event) ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/active_support/notifications/instrumenter.rb', line 140

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

#record ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# 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! ⇒ Object

Record information at the time this event starts



89
90
91
92
93
 
# File 'lib/active_support/notifications/instrumenter.rb', line 89

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