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.



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File '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
  @gc_time_start = 0
  @gc_time_finish = 0
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#payload ⇒ Object

Returns the value of attribute payload.



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

def payload
  @payload
end

#transaction_id ⇒ Object (readonly)

Returns the value of attribute transaction_id.



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

def transaction_id
  @transaction_id
end

Instance Method Details

#allocations ⇒ Object

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



176
177
178
 
# File 'lib/active_support/notifications/instrumenter.rb', line 176

def allocations
  @allocation_count_finish - @allocation_count_start
end

#cpu_time ⇒ Object

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



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

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 |event|
  @event = event
end

ActiveSupport::Notifications.instrument('wait') do
  sleep 1
end

@event.duration # => 1000.138



198
199
200
 
# File 'lib/active_support/notifications/instrumenter.rb', line 198

def duration
  @end - @time
end

#end ⇒ Object 



128
129
130
 
# File 'lib/active_support/notifications/instrumenter.rb', line 128

def end
  @end / 1000.0 if @end
end

#finish! ⇒ Object

Record information at the time this event finishes



154
155
156
157
158
159
 
# File 'lib/active_support/notifications/instrumenter.rb', line 154

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

#gc_time ⇒ Object

Returns the time spent in GC (in milliseconds) between the call to #start! and the call to #finish!



182
183
184
 
# File 'lib/active_support/notifications/instrumenter.rb', line 182

def gc_time
  (@gc_time_finish - @gc_time_start) / 1_000_000.0
end

#idle_time ⇒ Object

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



169
170
171
172
 
# File 'lib/active_support/notifications/instrumenter.rb', line 169

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

#record ⇒ Object

:nodoc:



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/active_support/notifications/instrumenter.rb', line 132

def record # :nodoc:
  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



146
147
148
149
150
151
 
# File 'lib/active_support/notifications/instrumenter.rb', line 146

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

#time ⇒ Object 



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

def time
  @time / 1000.0 if @time
end