-
Notifications
You must be signed in to change notification settings - Fork 399
/
profiler.rb
567 lines (460 loc) · 18.2 KB
/
profiler.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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
require 'json'
require 'timeout'
require 'thread'
require 'mini_profiler/version'
require 'mini_profiler/page_timer_struct'
require 'mini_profiler/sql_timer_struct'
require 'mini_profiler/custom_timer_struct'
require 'mini_profiler/client_timer_struct'
require 'mini_profiler/request_timer_struct'
require 'mini_profiler/storage/abstract_store'
require 'mini_profiler/storage/memcache_store'
require 'mini_profiler/storage/memory_store'
require 'mini_profiler/storage/redis_store'
require 'mini_profiler/storage/file_store'
require 'mini_profiler/config'
require 'mini_profiler/profiling_methods'
require 'mini_profiler/context'
require 'mini_profiler/client_settings'
require 'mini_profiler/gc_profiler'
# TODO
# require 'mini_profiler/gc_profiler_ruby_head' if Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION)
module Rack
class MiniProfiler
class << self
include Rack::MiniProfiler::ProfilingMethods
def generate_id
rand(36**20).to_s(36)
end
def reset_config
@config = Config.default
end
# So we can change the configuration if we want
def config
@config ||= Config.default
end
def share_template
return @share_template unless @share_template.nil?
@share_template = ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
end
def current
Thread.current[:mini_profiler_private]
end
def current=(c)
# we use TLS cause we need access to this from sql blocks and code blocks that have no access to env
Thread.current[:mini_profiler_private]= c
end
# discard existing results, don't track this request
def discard_results
self.current.discard = true if current
end
def create_current(env={}, options={})
# profiling the request
self.current = Context.new
self.current.inject_js = config.auto_inject && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
self.current.page_struct = PageTimerStruct.new(env)
self.current.current_timer = current.page_struct['Root']
end
def authorize_request
Thread.current[:mp_authorized] = true
end
def deauthorize_request
Thread.current[:mp_authorized] = nil
end
def request_authorized?
Thread.current[:mp_authorized]
end
end
#
# options:
# :auto_inject - should script be automatically injected on every html page (not xhr)
def initialize(app, config = nil)
MiniProfiler.config.merge!(config)
@config = MiniProfiler.config
@app = app
@config.base_url_path << "/" unless @config.base_url_path.end_with? "/"
unless @config.storage_instance
@config.storage_instance = @config.storage.new(@config.storage_options)
end
@storage = @config.storage_instance
end
def user(env)
@config.user_provider.call(env)
end
def serve_results(env)
request = Rack::Request.new(env)
id = request['id']
page_struct = @storage.load(id)
unless page_struct
@storage.set_viewed(user(env), id)
id = ERB::Util.html_escape(request['id'])
user_info = ERB::Util.html_escape(user(env))
return [404, {}, ["Request not found: #{id} - user #{user_info}"]]
end
unless page_struct['HasUserViewed']
page_struct['ClientTimings'] = ClientTimerStruct.init_from_form_data(env, page_struct)
page_struct['HasUserViewed'] = true
@storage.save(page_struct)
@storage.set_viewed(user(env), id)
end
result_json = page_struct.to_json
# If we're an XMLHttpRequest, serve up the contents as JSON
if request.xhr?
[200, { 'Content-Type' => 'application/json'}, [result_json]]
else
# Otherwise give the HTML back
html = MiniProfiler.share_template.dup
html.gsub!(/\{path\}/, "#{env['SCRIPT_NAME']}#{@config.base_url_path}")
html.gsub!(/\{version\}/, MiniProfiler::VERSION)
html.gsub!(/\{json\}/, result_json)
html.gsub!(/\{includes\}/, get_profile_script(env))
html.gsub!(/\{name\}/, page_struct['Name'])
html.gsub!(/\{duration\}/, "%.1f" % page_struct.duration_ms)
[200, {'Content-Type' => 'text/html'}, [html]]
end
end
def serve_html(env)
file_name = env['PATH_INFO'][(@config.base_url_path.length)..1000]
return serve_results(env) if file_name.eql?('results')
full_path = ::File.expand_path("../html/#{file_name}", ::File.dirname(__FILE__))
return [404, {}, ["Not found"]] unless ::File.exists? full_path
f = Rack::File.new nil
f.path = full_path
begin
f.cache_control = "max-age:86400"
f.serving env
rescue
# old versions of rack have a different api
status, headers, body = f.serving
headers.merge! 'Cache-Control' => "max-age:86400"
[status, headers, body]
end
end
def current
MiniProfiler.current
end
def current=(c)
MiniProfiler.current=c
end
def config
@config
end
def call(env)
client_settings = ClientSettings.new(env)
status = headers = body = nil
query_string = env['QUERY_STRING']
path = env['PATH_INFO']
skip_it = (@config.pre_authorize_cb && !@config.pre_authorize_cb.call(env)) ||
(@config.skip_paths && @config.skip_paths.any?{ |p| path[0,p.length] == p}) ||
query_string =~ /pp=skip/
has_profiling_cookie = client_settings.has_cookie?
if skip_it || (@config.authorization_mode == :whitelist && !has_profiling_cookie)
status,headers,body = @app.call(env)
if !skip_it && @config.authorization_mode == :whitelist && !has_profiling_cookie && MiniProfiler.request_authorized?
client_settings.write!(headers)
end
return [status,headers,body]
end
# handle all /mini-profiler requests here
return serve_html(env) if path.start_with? @config.base_url_path
has_disable_cookie = client_settings.disable_profiling?
# manual session disable / enable
if query_string =~ /pp=disable/ || has_disable_cookie
skip_it = true
end
if query_string =~ /pp=enable/ && (@config.authorization_mode != :whitelist || MiniProfiler.request_authorized?)
skip_it = false
config.enabled = true
end
if skip_it || !config.enabled
status,headers,body = @app.call(env)
client_settings.disable_profiling = true
client_settings.write!(headers)
return [status,headers,body]
else
client_settings.disable_profiling = false
end
if query_string =~ /pp=profile-gc/
current.measure = false if current
if query_string =~ /pp=profile-gc-time/
return Rack::MiniProfiler::GCProfiler.new.profile_gc_time(@app, env)
elsif query_string =~ /pp=profile-gc-ruby-head/
result = StringIO.new
report = MemoryProfiler.report do
_,_,body = @app.call(env)
body.close if body.respond_to? :close
end
report.pretty_print(result)
return text_result(result.string)
else
return Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env)
end
end
MiniProfiler.create_current(env, @config)
MiniProfiler.deauthorize_request if @config.authorization_mode == :whitelist
if query_string =~ /pp=normal-backtrace/
client_settings.backtrace_level = ClientSettings::BACKTRACE_DEFAULT
elsif query_string =~ /pp=no-backtrace/
current.skip_backtrace = true
client_settings.backtrace_level = ClientSettings::BACKTRACE_NONE
elsif query_string =~ /pp=full-backtrace/ || client_settings.backtrace_full?
current.full_backtrace = true
client_settings.backtrace_level = ClientSettings::BACKTRACE_FULL
elsif client_settings.backtrace_none?
current.skip_backtrace = true
end
flamegraph = nil
trace_exceptions = query_string =~ /pp=trace-exceptions/ && defined? TracePoint
status, headers, body, exceptions,trace = nil
start = Time.now
if trace_exceptions
exceptions = []
trace = TracePoint.new(:raise) do |tp|
exceptions << tp.raised_exception
end
trace.enable
end
begin
# Strip all the caching headers so we don't get 304s back
# This solves a very annoying bug where rack mini profiler never shows up
env['HTTP_IF_MODIFIED_SINCE'] = ''
env['HTTP_IF_NONE_MATCH'] = ''
if query_string =~ /pp=flamegraph/
unless defined?(Flamegraph) && Flamegraph.respond_to?(:generate)
flamegraph = "Please install the flamegraph gem and require it: add gem 'flamegraph' to your Gemfile"
status,headers,body = @app.call(env)
else
# do not sully our profile with mini profiler timings
current.measure = false
match_data = query_string.match(/flamegraph_sample_rate=([\d\.]+)/)
mode = query_string =~ /mode=c/ ? :c : :ruby
if match_data && !match_data[1].to_f.zero?
sample_rate = match_data[1].to_f
else
sample_rate = config.flamegraph_sample_rate
end
flamegraph = Flamegraph.generate(nil, :fidelity => sample_rate, :embed_resources => query_string =~ /embed/, :mode => mode) do
status,headers,body = @app.call(env)
end
end
else
status,headers,body = @app.call(env)
end
client_settings.write!(headers)
ensure
trace.disable if trace
end
skip_it = current.discard
if (config.authorization_mode == :whitelist && !MiniProfiler.request_authorized?)
# this is non-obvious, don't kill the profiling cookie on errors or short requests
# this ensures that stuff that never reaches the rails stack does not kill profiling
if status == 200 && ((Time.now - start) > 0.1)
client_settings.discard_cookie!(headers)
end
skip_it = true
end
return [status,headers,body] if skip_it
# we must do this here, otherwise current[:discard] is not being properly treated
if trace_exceptions
body.close if body.respond_to? :close
return dump_exceptions exceptions
end
if query_string =~ /pp=env/
body.close if body.respond_to? :close
return dump_env env
end
if query_string =~ /pp=help/
body.close if body.respond_to? :close
return help(client_settings)
end
page_struct = current.page_struct
page_struct['User'] = user(env)
page_struct['Root'].record_time((Time.now - start) * 1000)
if flamegraph
body.close if body.respond_to? :close
return self.flamegraph(flamegraph)
end
begin
# no matter what it is, it should be unviewed, otherwise we will miss POST
@storage.set_unviewed(page_struct['User'], page_struct['Id'])
@storage.save(page_struct)
# inject headers, script
if headers['Content-Type'] && status == 200
client_settings.write!(headers)
result = inject_profiler(env,status,headers,body)
return result if result
end
rescue Exception => e
if @config.storage_failure != nil
@config.storage_failure.call(e)
end
end
client_settings.write!(headers)
[status, headers, body]
ensure
# Make sure this always happens
self.current = nil
end
def inject_profiler(env,status,headers,body)
# mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
# Rack::ETag has already inserted some nonesense in the chain
content_type = headers['Content-Type']
headers.delete('ETag')
headers.delete('Date')
headers['Cache-Control'] = 'no-store, must-revalidate, private, max-age=0'
# inject header
if headers.is_a? Hash
headers['X-MiniProfiler-Ids'] = ids_json(env)
end
if current.inject_js && content_type =~ /text\/html/
response = Rack::Response.new([], status, headers)
script = self.get_profile_script(env)
if String === body
response.write inject(body,script)
else
body.each { |fragment| response.write inject(fragment, script) }
end
body.close if body.respond_to? :close
response.finish
else
nil
end
end
def inject(fragment, script)
if fragment.match(/<\/body>/i)
# explicit </body>
regex = /<\/body>/i
close_tag = '</body>'
elsif fragment.match(/<\/html>/i)
# implicit </body>
regex = /<\/html>/i
close_tag = '</html>'
else
# implicit </body> and </html>. Don't do anything.
return fragment
end
matches = fragment.scan(regex).length
index = 1
fragment.gsub(regex) do
# though malformed there is an edge case where /body exists earlier in the html, work around
if index < matches
index += 1
close_tag
else
# if for whatever crazy reason we dont get a utf string,
# just force the encoding, no utf in the mp scripts anyway
if script.respond_to?(:encoding) && script.respond_to?(:force_encoding)
(script + close_tag).force_encoding(fragment.encoding)
else
script + close_tag
end
end
end
end
def dump_exceptions(exceptions)
headers = {'Content-Type' => 'text/plain'}
body = "Exceptions (#{exceptions.length} raised during request)\n\n"
exceptions.each do |e|
body << "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}\n\n\n\n"
end
[200, headers, [body]]
end
def dump_env(env)
body = "Rack Environment\n---------------\n"
env.each do |k,v|
body << "#{k}: #{v}\n"
end
body << "\n\nEnvironment\n---------------\n"
ENV.each do |k,v|
body << "#{k}: #{v}\n"
end
body << "\n\nRuby Version\n---------------\n"
body << "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL}\n"
body << "\n\nInternals\n---------------\n"
body << "Storage Provider #{config.storage_instance}\n"
body << "User #{user(env)}\n"
body << config.storage_instance.diagnostics(user(env)) rescue "no diagnostics implemented for storage"
text_result(body)
end
def text_result(body)
headers = {'Content-Type' => 'text/plain'}
[200, headers, [body]]
end
def help(client_settings)
headers = {'Content-Type' => 'text/plain'}
body = "Append the following to your query string:
pp=help : display this screen
pp=env : display the rack environment
pp=skip : skip mini profiler for this request
pp=no-backtrace #{"(*) " if client_settings.backtrace_none?}: don't collect stack traces from all the SQL executed (sticky, use pp=normal-backtrace to enable)
pp=normal-backtrace #{"(*) " if client_settings.backtrace_default?}: collect stack traces from all the SQL executed and filter normally
pp=full-backtrace #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use pp=normal-backtrace to disable)
pp=disable : disable profiling for this session
pp=enable : enable profiling for this session (if previously disabled)
pp=profile-gc: perform gc profiling on this request, analyzes ObjectSpace generated by request (ruby 1.9.3 only)
pp=profile-gc-time: perform built-in gc profiling on this request (ruby 1.9.3 only)
pp=profile-gc-ruby-head: requires the memory_profiler gem, new location based report
pp=flamegraph: works best on Ruby 2.0, a graph representing sampled activity (requires the flamegraph gem).
pp=flamegraph&flamegraph_sample_rate=1: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
pp=flamegraph_embed: works best on Ruby 2.0, a graph representing sampled activity (requires the flamegraph gem), embedded resources for use on an intranet.
pp=trace-exceptions: requires Ruby 2.0, will return all the spots where your application raises execptions
"
client_settings.write!(headers)
[200, headers, [body]]
end
def flamegraph(graph)
headers = {'Content-Type' => 'text/html'}
[200, headers, [graph]]
end
def ids(env)
# cap at 10 ids, otherwise there is a chance you can blow the header
([current.page_struct["Id"]] + (@storage.get_unviewed_ids(user(env)) || [])[0..8]).uniq
end
def ids_json(env)
::JSON.generate(ids(env))
end
def ids_comma_separated(env)
ids(env).join(",")
end
# get_profile_script returns script to be injected inside current html page
# By default, profile_script is appended to the end of all html requests automatically.
# Calling get_profile_script cancels automatic append for the current page
# Use it when:
# * you have disabled auto append behaviour throught :auto_inject => false flag
# * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject
def get_profile_script(env)
settings = {
:path => "#{env['SCRIPT_NAME']}#{@config.base_url_path}",
:version => MiniProfiler::VERSION,
:position => @config.position,
:showTrivial => false,
:showChildren => false,
:maxTracesToShow => 10,
:showControls => false,
:authorized => true,
:toggleShortcut => @config.toggle_shortcut,
:startHidden => @config.start_hidden
}
if current && current.page_struct
settings[:ids] = ids_comma_separated(env)
settings[:currentId] = current.page_struct["Id"]
else
settings[:ids] = []
settings[:currentId] = ""
end
# TODO : cache this snippet
script = IO.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
# replace the variables
settings.each do |k,v|
regex = Regexp.new("\\{#{k.to_s}\\}")
script.gsub!(regex, v.to_s)
end
current.inject_js = false if current
script
end
# cancels automatic injection of profile script for the current page
def cancel_auto_inject(env)
current.inject_js = false
end
end
end