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
|
# frozen_string_literal: true
# :markup: markdown
require "benchmark"
require "abstract_controller/logger"
module ActionController
# # Action Controller Instrumentation
#
# Adds instrumentation to several ends in ActionController::Base. It also
# provides some hooks related with process_action. This allows an ORM like
# Active Record and/or DataMapper to plug in ActionController and show related
# information.
#
# Check ActiveRecord::Railties::ControllerRuntime for an example.
module Instrumentation
extend ActiveSupport::Concern
include AbstractController::Logger
attr_internal :view_runtime
def initialize(...) # :nodoc:
super
self.view_runtime = nil
end
def render(*)
render_output = nil
self.view_runtime = cleanup_view_runtime do
Benchmark.ms { render_output = super }
end
render_output
end
def send_file(path, options = {})
ActiveSupport::Notifications.instrument("send_file.action_controller",
options.merge(path: path)) do
super
end
end
def send_data(data, options = {})
ActiveSupport::Notifications.instrument("send_data.action_controller", options) do
super
end
end
def redirect_to(*)
ActiveSupport::Notifications.instrument("redirect_to.action_controller", request: request) do |payload|
result = super
payload[:status] = response.status
payload[:location] = response.filtered_location
result
end
end
private
def process_action(*)
ActiveSupport::ExecutionContext[:controller] = self
raw_payload = {
controller: self.class.name,
action: action_name,
request: request,
params: request.filtered_parameters,
headers: request.headers,
format: request.format.ref,
method: request.request_method,
path: request.filtered_path
}
ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload)
ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
result = super
payload[:response] = response
payload[:status] = response.status
result
rescue => error
payload[:status] = ActionDispatch::ExceptionWrapper.status_code_for_exception(error.class.name)
raise
ensure
append_info_to_payload(payload)
end
end
# A hook invoked every time a before callback is halted.
def halted_callback_hook(filter, _)
ActiveSupport::Notifications.instrument("halted_callback.action_controller", filter: filter)
end
# A hook which allows you to clean up any time, wrongly taken into account in
# views, like database querying time.
#
# def cleanup_view_runtime
# super - time_taken_in_something_expensive
# end
def cleanup_view_runtime # :doc:
yield
end
# Every time after an action is processed, this method is invoked with the
# payload, so you can add more information.
def append_info_to_payload(payload) # :doc:
payload[:view_runtime] = view_runtime
end
module ClassMethods
# A hook which allows other frameworks to log what happened during controller
# process action. This method should return an array with the messages to be
# added.
def log_process_action(payload) # :nodoc:
messages, view_runtime = [], payload[:view_runtime]
messages << ("Views: %.1fms" % view_runtime.to_f) if view_runtime
messages
end
end
end
end
|
