Module: ActionController::Instrumentation

Relationships & Source Files
Namespace Children
Modules: ClassMethods
Extension / Inclusion / Inheritance Descendants
Included In: Base, ::ActionView::TestCase::TestController, Rails::ApplicationController, Rails::InfoController, Rails::MailersController, Rails::WelcomeController
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ::ActiveSupport::Concern
Instance Chain: self, RackDelegation, ::ActiveSupport::Benchmarkable
Defined in:	actionpack/lib/action_controller/metal/instrumentation.rb

Overview

Adds instrumentation to several ends in 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.

::AbstractController::Logger - Attributes & Methods

.logger rw
#logger rw

Class Method Summary

::ActiveSupport::Concern - Extended

append_features, class_methods, included

Instance Attribute Summary

#view_runtime rw

RackDelegation - Included

#content_type, #headers, #location, #response_body=, #response_code, #status

RackDelegation - Included

#dispatch, #reset_session

::ActiveSupport::Benchmarkable - self

#benchmark

Allows you to measure the execution time of a block in a template and records the result to the log.

Class Attribute Details

.logger (rw)

[ GitHub ]

# File 'actionpack/lib/abstract_controller/logger.rb', line 8


config_accessor :logger

Instance Attribute Details

#logger (rw)

[ GitHub ]

# File 'actionpack/lib/abstract_controller/logger.rb', line 8


config_accessor :logger

#view_runtime (rw)

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 16


attr_internal :view_runtime

Instance Method Details

#process_action(*args)

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 18


def process_action(*args)
  raw_payload = {
    :controller => self.class.name,
    :action     => self.action_name,
    :params     => request.filtered_parameters,
    :format     => request.format.try(:ref),
    :method     => request.request_method,
    :path       => (request.fullpath rescue "unknown")
  }

  ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)

  ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
    begin
      result = super
      payload[:status] = response.status
      result
    ensure
      append_info_to_payload(payload)
    end
  end
end

#redirect_to(*args)

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 62


def redirect_to(*args)
  ActiveSupport::Notifications.instrument("redirect_to.action_controller") do |payload|
    result = super
    payload[:status]   = response.status
    payload[:location] = response.filtered_location
    result
  end
end

#render(*args)

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 41


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

#send_data(data, options = {})

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 56


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

#send_file(path, options = {})

[ GitHub ]

# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 49


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