aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/metal/instrumentation.rb
blob: 91d454f0c398290d3d79cc98d66b10d4c4a64926 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
require 'abstract_controller/logger'

module ActionController
  # Adds instrumentation to several ends in ActionController::Base. It also provides
  # some hooks related with process_action logging and view runtime.
  module Instrumentation
    extend ActiveSupport::Concern

    included do
      include AbstractController::Logger
    end

    attr_internal :view_runtime

    def process_action(action, *args)
      ActiveSupport::Notifications.instrument("action_controller.process_action",
        :controller => self, :action => action) do
        super
      end
    end

    def render(*args, &block)
      if logger
        render_output = nil

        self.view_runtime = cleanup_view_runtime do
          Benchmark.ms { render_output = super }
        end

        render_output
      else
        super
      end
    end

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

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

    def redirect_to(*args)
      super
      ActiveSupport::Notifications.instrument("action_controller.redirect_to",
        :status => self.status, :location => self.location)
    end

    # A hook which allows you to clean up any time taken into account in
    # views wrongly, like database querying time.
    #
    #   def cleanup_view_runtime
    #     super - time_taken_in_something_expensive
    #   end
    #
    # :api: plugin
    def cleanup_view_runtime #:nodoc:
      yield
    end

    module ClassMethods
      # A hook which allows other frameworks to log what happened during
      # controller process action.
      # :api: plugin
      def log_process_action(controller) #:nodoc:
        view_runtime = controller.send :view_runtime
        logger.info("  View runtime: %.1fms" % view_runtime.to_f) if view_runtime
      end
    end
  end
end