Module: ActionController::Instrumentation
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
API ,
Base ,
::ActionView::TestCase::TestController ,
Rails::ApplicationController,
::Rails::HealthController ,
Rails::InfoController,
Rails::MailersController,
Rails::WelcomeController
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Instance Chain:
|
|
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
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
Instance Attribute Summary
Instance Method Summary
- #redirect_to
- #render
- #send_data(data, options = {})
- #send_file(path, options = {})
-
#append_info_to_payload(payload)
private
Every time after an action is processed, this method is invoked with the payload, so you can add more information.
-
#cleanup_view_runtime
private
A hook which allows you to clean up any time, wrongly taken into account in views, like database querying time.
::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 10
config_accessor :logger
Instance Attribute Details
#logger (rw)
[ GitHub ]# File 'actionpack/lib/abstract_controller/logger.rb', line 10
config_accessor :logger
#view_runtime (rw)
[ GitHub ]# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 19
attr_internal :view_runtime
Instance Method Details
#append_info_to_payload(payload) (private)
Every time after an action is processed, this method is invoked with the payload, so you can add more information.
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 103
def append_info_to_payload(payload) # :doc: payload[:view_runtime] = view_runtime end
#cleanup_view_runtime (private)
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
# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 97
def cleanup_view_runtime # :doc: yield end
#redirect_to
[ GitHub ]# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 47
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
[ GitHub ]# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 26
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 = {})
[ GitHub ]# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 41
def send_data(data, = {}) ActiveSupport::Notifications.instrument("send_data.action_controller", ) do super end end
#send_file(path, options = {})
[ GitHub ]# File 'actionpack/lib/action_controller/metal/instrumentation.rb', line 34
def send_file(path, = {}) ActiveSupport::Notifications.instrument("send_file.action_controller", .merge(path: path)) do super end end