-
Notifications
You must be signed in to change notification settings - Fork 596
/
method_tracer_test.rb
386 lines (322 loc) · 10.5 KB
/
method_tracer_test.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
require 'new_relic/agent/mock_scope_listener'
class Module
def method_traced?(method_name, metric_name)
traced_method_prefix = _traced_method_name(method_name, metric_name)
method_defined? traced_method_prefix
end
end
class Insider
def initialize(stats_engine)
@stats_engine = stats_engine
end
def catcher(level=0)
thrower(level) if level>0
end
def thrower(level)
if level == 0
# don't use a real sampler because we can't instantiate one
# sampler = NewRelic::Agent::TransactionSampler.new(NewRelic::Agent.instance)
sampler = "<none>"
begin
@stats_engine.transaction_sampler = sampler
fail "This should not have worked."
rescue; end
else
thrower(level-1)
end
end
end
module NewRelic
module Agent
extend self
def module_method_to_be_traced (x, testcase)
testcase.assert x == "x"
testcase.assert testcase.stats_engine.peek_scope.name == "x"
end
end
end
module TestModuleWithLog
extend self
def other_method
#just here to be traced
log "12345"
end
def log( msg )
msg
end
include NewRelic::Agent::MethodTracer
add_method_tracer :other_method, 'Custom/foo/bar'
end
class NewRelic::Agent::MethodTracerTest < Test::Unit::TestCase
attr_reader :stats_engine
def setup
NewRelic::Agent.manual_start
@stats_engine = NewRelic::Agent.instance.stats_engine
@stats_engine.clear_stats
@scope_listener = NewRelic::Agent::MockScopeListener.new
@old_sampler = NewRelic::Agent.instance.transaction_sampler
@stats_engine.transaction_sampler = @scope_listener
super
end
def teardown
@stats_engine.transaction_sampler = @old_sampler
@stats_engine.clear_stats
begin
self.class.remove_method_tracer :method_to_be_traced, @metric_name if @metric_name
rescue RuntimeError
# ignore 'no tracer' errors from remove method tracer
end
@metric_name = nil
super
end
def test_preserve_logging
assert_equal '12345', TestModuleWithLog.other_method
end
def test_basic
metric = "hello"
t1 = Time.now
self.class.trace_execution_scoped metric do
sleep 0.05
assert metric == @stats_engine.peek_scope.name
end
elapsed = Time.now - t1
stats = @stats_engine.get_stats(metric)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
def test_basic__original_api
metric = "hello"
t1 = Time.now
self.class.trace_method_execution metric, true, true, true do
sleep 0.05
assert metric == @stats_engine.peek_scope.name
end
elapsed = Time.now - t1
stats = @stats_engine.get_stats(metric)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
METRIC = "metric"
def test_add_method_tracer
@metric_name = METRIC
self.class.add_method_tracer :method_to_be_traced, METRIC
t1 = Time.now
method_to_be_traced 1,2,3,true,METRIC
elapsed = Time.now - t1
begin
self.class.remove_method_tracer :method_to_be_traced, METRIC
rescue RuntimeError
# ignore 'no tracer' errors from remove method tracer
end
stats = @stats_engine.get_stats(METRIC)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
def test_add_method_tracer__default
self.class.add_method_tracer :simple_method
simple_method
stats = @stats_engine.get_stats("Custom/#{self.class.name}/simple_method")
assert stats.call_count == 1
end
def test_add_method_tracer__reentry
self.class.add_method_tracer :simple_method
self.class.add_method_tracer :simple_method
self.class.add_method_tracer :simple_method
simple_method
stats = @stats_engine.get_stats("Custom/#{self.class.name}/simple_method")
assert stats.call_count == 1
end
def test_method_traced?
assert !self.class.method_traced?(:method_to_be_traced, METRIC)
self.class.add_method_tracer :method_to_be_traced, METRIC
assert self.class.method_traced?(:method_to_be_traced, METRIC)
begin
self.class.remove_method_tracer :method_to_be_traced, METRIC
rescue RuntimeError
# ignore 'no tracer' errors from remove method tracer
end
end
def test_tt_only
assert_nil @scope_listener.scope["c2"]
self.class.add_method_tracer :method_c1, "c1", :push_scope => true
self.class.add_method_tracer :method_c2, "c2", :metric => false
self.class.add_method_tracer :method_c3, "c3", :push_scope => false
method_c1
assert_not_nil @stats_engine.lookup_stats("c1")
assert_nil @stats_engine.lookup_stats("c2")
assert_not_nil @stats_engine.lookup_stats("c3")
assert_not_nil @scope_listener.scope["c2"]
end
def test_nested_scope_tracer
Insider.add_method_tracer :catcher, "catcher", :push_scope => true
Insider.add_method_tracer :thrower, "thrower", :push_scope => true
sampler = NewRelic::Agent.instance.transaction_sampler
mock = Insider.new(@stats_engine)
mock.catcher(0)
mock.catcher(5)
stats = @stats_engine.get_stats("catcher")
assert_equal 2, stats.call_count
stats = @stats_engine.get_stats("thrower")
assert_equal 6, stats.call_count
sample = sampler.harvest
assert_not_nil sample
end
def test_add_same_tracer_twice
@metric_name = METRIC
self.class.add_method_tracer :method_to_be_traced, METRIC
self.class.add_method_tracer :method_to_be_traced, METRIC
t1 = Time.now
method_to_be_traced 1,2,3,true,METRIC
elapsed = Time.now - t1
begin
self.class.remove_method_tracer :method_to_be_traced, METRIC
rescue RuntimeError
# ignore 'no tracer' errors from remove method tracer
end
stats = @stats_engine.get_stats(METRIC)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
def test_add_tracer_with_dynamic_metric
metric_code = '#{args[0]}.#{args[1]}'
@metric_name = metric_code
expected_metric = "1.2"
self.class.add_method_tracer :method_to_be_traced, metric_code
t1 = Time.now
method_to_be_traced 1,2,3,true,expected_metric
elapsed = Time.now - t1
begin
self.class.remove_method_tracer :method_to_be_traced, metric_code
rescue RuntimeError
# ignore 'no tracer' errors from remove method tracer
end
stats = @stats_engine.get_stats(expected_metric)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
def test_trace_method_with_block
self.class.add_method_tracer :method_with_block, METRIC
t1 = Time.now
method_with_block(1,2,3,true,METRIC) do |scope|
assert scope == METRIC
end
elapsed = Time.now - t1
stats = @stats_engine.get_stats(METRIC)
check_time stats.total_call_time, elapsed
assert stats.call_count == 1
end
def test_trace_module_method
NewRelic::Agent.add_method_tracer :module_method_to_be_traced, '#{args[0]}'
NewRelic::Agent.module_method_to_be_traced "x", self
NewRelic::Agent.remove_method_tracer :module_method_to_be_traced, '#{args[0]}'
end
def test_remove
self.class.add_method_tracer :method_to_be_traced, METRIC
self.class.remove_method_tracer :method_to_be_traced, METRIC
t1 = Time.now
method_to_be_traced 1,2,3,false,METRIC
elapsed = Time.now - t1
stats = @stats_engine.get_stats(METRIC)
assert stats.call_count == 0
end
def self.static_method(x, testcase, is_traced)
testcase.assert x == "x"
testcase.assert((testcase.stats_engine.peek_scope.name == "x") == is_traced)
end
def trace_trace_static_method
self.add_method_tracer :static_method, '#{args[0]}'
self.class.static_method "x", self, true
self.remove_method_tracer :static_method, '#{args[0]}'
self.class.static_method "x", self, false
end
def test_multiple_metrics__scoped
metrics = %w[first second third]
self.class.trace_execution_scoped metrics do
sleep 0.05
end
elapsed = @stats_engine.get_stats('first').average_call_time
metrics.map{|name| @stats_engine.get_stats name}.each do | m |
assert_equal 1, m.call_count
assert_equal elapsed, m.total_call_time
end
end
def test_multiple_metrics__unscoped
metrics = %w[first second third]
self.class.trace_execution_unscoped metrics do
sleep 0.05
end
elapsed = @stats_engine.get_stats('first').average_call_time
metrics.map{|name| @stats_engine.get_stats name}.each do | m |
assert_equal 1, m.call_count
assert_equal elapsed, m.total_call_time
end
end
def test_exception
begin
metric = "hey"
self.class.trace_execution_scoped metric do
assert @stats_engine.peek_scope.name == metric
throw StandardError.new
end
assert false # should never get here
rescue StandardError
# make sure the scope gets popped
assert @stats_engine.peek_scope == nil
end
stats = @stats_engine.get_stats metric
assert stats.call_count == 1
end
def test_add_multiple_tracers
self.class.add_method_tracer :method_to_be_traced, 'X', :push_scope => false
method_to_be_traced 1,2,3,true,nil
self.class.add_method_tracer :method_to_be_traced, 'Y'
method_to_be_traced 1,2,3,true,'Y'
self.class.remove_method_tracer :method_to_be_traced, 'Y'
method_to_be_traced 1,2,3,true,nil
self.class.remove_method_tracer :method_to_be_traced, 'X'
method_to_be_traced 1,2,3,false,'X'
end
def trace_no_push_scope
self.class.add_method_tracer :method_to_be_traced, 'X', :push_scope => false
method_to_be_traced 1,2,3,true,nil
self.class.remove_method_tracer :method_to_be_traced, 'X'
method_to_be_traced 1,2,3,false,'X'
end
def check_time(t1, t2)
assert_in_delta t2, t1, 0.05
end
# =======================================================
# test methods to be traced
def method_to_be_traced(x, y, z, is_traced, expected_metric)
sleep 0.01
assert x == 1
assert y == 2
assert z == 3
scope_name = @stats_engine.peek_scope ? @stats_engine.peek_scope.name : nil
if is_traced
assert_equal expected_metric, scope_name
else
assert_not_equal expected_metric, scope_name
end
end
def method_with_block(x, y, z, is_traced, expected_metric, &block)
sleep 0.01
assert x == 1
assert y == 2
assert z == 3
block.call(@stats_engine.peek_scope.name)
scope_name = @stats_engine.peek_scope ? @stats_engine.peek_scope.name : nil
assert((expected_metric == scope_name) == is_traced)
end
def method_c1
method_c2
end
def method_c2
method_c3
end
def method_c3
end
def simple_method
end
end