summaryrefslogtreecommitdiff
path: root/lib/gitlab/metrics/base_sampler.rb
blob: 219accfc029459510b429f79ba772e42559192f8 (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
require 'logger'
module Gitlab
  module Metrics
    class BaseSampler
      def self.initialize_instance(*args)
        raise "#{name} singleton instance already initialized" if @instance
        @instance = new(*args)
        at_exit(&@instance.method(:stop))
        @instance
      end

      def self.instance
        @instance
      end

      attr_reader :running

      # interval - The sampling interval in seconds.
      def initialize(interval)
        interval_half = interval.to_f / 2

        @interval = interval
        @interval_steps = (-interval_half..interval_half).step(0.1).to_a

        @mutex = Mutex.new
      end

      def enabled?
        true
      end

      def start
        return unless enabled?

        @mutex.synchronize do
          return if running
          @running = true

          @thread = Thread.new do
            sleep(sleep_interval)

            while running
              safe_sample

              sleep(sleep_interval)
            end
          end
        end
      end

      def stop
        @mutex.synchronize do
          return unless running

          @running = false

          if @thread
            @thread.wakeup if @thread.alive?
            @thread.join
            @thread = nil
          end
        end
      end

      def safe_sample
        sample
      rescue => e
        Rails.logger.warn("#{self.class}: #{e}, stopping")
        stop
      end

      def sample
        raise NotImplementedError
      end

      # Returns the sleep interval with a random adjustment.
      #
      # The random adjustment is put in place to ensure we:
      #
      # 1. Don't generate samples at the exact same interval every time (thus
      #    potentially missing anything that happens in between samples).
      # 2. Don't sample data at the same interval two times in a row.
      def sleep_interval
        while step = @interval_steps.sample
          if step != @last_step
            @last_step = step

            return @interval + @last_step
          end
        end
      end
    end
  end
end