summaryrefslogtreecommitdiff
path: root/lib/gitlab/metrics/method_call.rb
blob: 5177d953795ad18134e533d28631c8a4b1ce9b2c (plain)
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
module Gitlab
  module Metrics
    # Class for tracking timing information about method calls
    class MethodCall
      MUTEX = Mutex.new
      BASE_LABELS = { module: nil, method: nil }.freeze
      attr_reader :real_time, :cpu_time, :call_count, :labels

      def self.call_real_duration_histogram
        return @call_real_duration_histogram if @call_real_duration_histogram

        MUTEX.synchronize do
          @call_real_duration_histogram ||= Gitlab::Metrics.histogram(
            :gitlab_method_call_real_duration_seconds,
            'Method calls real duration',
            Transaction::BASE_LABELS.merge(BASE_LABELS),
            [0.1, 0.2, 0.5, 1, 2, 5, 10]
          )
        end
      end

      def self.call_cpu_duration_histogram
        return @call_cpu_duration_histogram if @call_cpu_duration_histogram

        MUTEX.synchronize do
          @call_duration_histogram ||= Gitlab::Metrics.histogram(
            :gitlab_method_call_cpu_duration_seconds,
            'Method calls cpu duration',
            Transaction::BASE_LABELS.merge(BASE_LABELS),
            [0.1, 0.2, 0.5, 1, 2, 5, 10]
          )
        end
      end

      # name - The full name of the method (including namespace) such as
      #        `User#sign_in`.
      #
      def initialize(name, module_name, method_name, transaction)
        @module_name = module_name
        @method_name = method_name
        @transaction = transaction
        @name = name
        @labels = { module: @module_name, method: @method_name }
        @real_time = 0
        @cpu_time = 0
        @call_count = 0
      end

      # Measures the real and CPU execution time of the supplied block.
      def measure
        start_real = System.monotonic_time
        start_cpu = System.cpu_time
        retval = yield

        real_time = System.monotonic_time - start_real
        cpu_time = System.cpu_time - start_cpu

        @real_time += real_time
        @cpu_time += cpu_time
        @call_count += 1

        if prometheus_enabled?
          self.class.call_real_duration_histogram.observe(@transaction.labels.merge(labels), real_time / 1000.0)
          self.class.call_cpu_duration_histogram.observe(@transaction.labels.merge(labels), cpu_time / 1000.0)
        end

        retval
      end

      # Returns a Metric instance of the current method call.
      def to_metric
        Metric.new(
          Instrumentation.series,
          {
            duration: real_time,
            cpu_duration: cpu_time,
            call_count: call_count
          },
          method: @name
        )
      end

      # Returns true if the total runtime of this method exceeds the method call
      # threshold.
      def above_threshold?
        real_time >= Metrics.method_call_threshold
      end

      def prometheus_enabled?
        @prometheus_enabled ||= current_application_settings(:prometheus_metrics_method_instrumentation_enabled)
      end
    end
  end
end