ActionController::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.

Namespace

Module

ActionController::Instrumentation::ClassMethods

Instance Public methods

process_action(*)

📝 Source code

# 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

🔎 See on GitHub

redirect_to(*)

📝 Source code

# 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

🔎 See on GitHub

render(*)

📝 Source code

# 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

🔎 See on GitHub

send_data(data, options = {})

📝 Source code

# 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

🔎 See on GitHub

send_file(path, options = {})

📝 Source code

# 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

🔎 See on GitHub

Instance Private 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

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

🔎 See on GitHub

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

# File actionpack/lib/action_controller/metal/instrumentation.rb, line 85
    def cleanup_view_runtime # :doc:
      yield
    end

🔎 See on GitHub