Skip to Content Skip to Search

module ActionController::Instrumentation

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.

Public instance methods

redirect_to(*)

Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 50
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(*)

Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 29
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 = {})

Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 44
def send_data(data, options = {})
  ActiveSupport::Notifications.instrument("send_data.action_controller", options) do
    super
  end
end

send_file(path, options = {})

Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 37
def send_file(path, options = {})
  ActiveSupport::Notifications.instrument("send_file.action_controller",
    options.merge(path: path)) do
    super
  end
end

Private instance methods

append_info_to_payload(payload)

Every time after an action is processed, this method is invoked with the payload, so you can add more information.

Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 106
def append_info_to_payload(payload) # :doc:
  payload[:view_runtime] = view_runtime
end

cleanup_view_runtime()

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
Source code GitHub 
# File actionpack/lib/action_controller/metal/instrumentation.rb, line 100
def cleanup_view_runtime # :doc:
  yield
end

Namespace

Definition files