Module: ActionController::Instrumentation

Extended by:
ActiveSupport::Concern
Includes:
AbstractController::Logger
Defined in:
actionpack/lib/action_controller/metal/instrumentation.rb

Overview

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.

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

Instance Method Details

#process_action ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 19

def process_action(*)
  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.fullpath
  }

  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
  ensure
    append_info_to_payload(payload)
  end
end

#redirect_to ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 64

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

#render ⇒ Object 



43
44
45
46
47
48
49
 
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 43

def render(*)
  render_output = nil
  self.view_runtime = cleanup_view_runtime do
    Benchmark.ms { render_output = super }
  end
  render_output
end

#send_data(data, options = {}) ⇒ Object 



58
59
60
61
62
 
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 58

def send_data(data, options = {})
  ActiveSupport::Notifications.instrument("send_data.action_controller", options) do
    super
  end
end

#send_file(path, options = {}) ⇒ Object 



51
52
53
54
55
56
 
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 51

def send_file(path, options = {})
  ActiveSupport::Notifications.instrument("send_file.action_controller",
    options.merge(path: path)) do
    super
  end
end