2018-11-17 00:37:17 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-08-10 14:18:37 +00:00
|
|
|
require 'logger'
|
2017-09-04 23:34:28 +00:00
|
|
|
|
2017-08-10 14:18:37 +00:00
|
|
|
module Gitlab
|
|
|
|
module Metrics
|
|
|
|
module Samplers
|
2017-09-04 20:14:54 +00:00
|
|
|
class BaseSampler < Daemon
|
2020-05-28 03:08:08 +00:00
|
|
|
attr_reader :interval
|
|
|
|
|
2017-08-10 14:18:37 +00:00
|
|
|
# interval - The sampling interval in seconds.
|
2021-12-20 15:12:25 +00:00
|
|
|
# warmup - When true, takes a single sample eagerly before entering the sampling loop.
|
|
|
|
# This can be useful to ensure that all metrics files exist after `start` returns,
|
|
|
|
# since prometheus-client-mmap creates them lazily upon first access.
|
|
|
|
def initialize(interval: nil, logger: Logger.new($stdout), warmup: false, **options)
|
2020-12-29 18:10:10 +00:00
|
|
|
interval ||= ENV[interval_env_key]&.to_i
|
|
|
|
interval ||= self.class::DEFAULT_SAMPLING_INTERVAL_SECONDS
|
2017-08-10 14:18:37 +00:00
|
|
|
interval_half = interval.to_f / 2
|
|
|
|
|
|
|
|
@interval = interval
|
|
|
|
@interval_steps = (-interval_half..interval_half).step(0.1).to_a
|
|
|
|
|
2021-12-20 15:12:25 +00:00
|
|
|
@logger = logger
|
|
|
|
@warmup = warmup
|
|
|
|
|
|
|
|
super(**options)
|
2017-08-10 14:18:37 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def safe_sample
|
|
|
|
sample
|
2021-04-26 12:09:44 +00:00
|
|
|
rescue StandardError => e
|
2021-12-20 15:12:25 +00:00
|
|
|
@logger.warn("#{self.class}: #{e}, stopping")
|
2017-08-10 14:18:37 +00:00
|
|
|
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
|
2017-09-04 20:14:54 +00:00
|
|
|
|
|
|
|
private
|
|
|
|
|
2017-09-04 23:34:28 +00:00
|
|
|
attr_reader :running
|
|
|
|
|
2020-12-29 18:10:10 +00:00
|
|
|
def sampler_class
|
|
|
|
self.class.name.demodulize
|
|
|
|
end
|
|
|
|
|
|
|
|
def interval_env_key
|
|
|
|
"#{sampler_class.underscore.upcase}_INTERVAL_SECONDS"
|
|
|
|
end
|
|
|
|
|
2017-09-04 20:14:54 +00:00
|
|
|
def start_working
|
|
|
|
@running = true
|
2019-10-16 09:07:51 +00:00
|
|
|
|
2021-12-20 15:12:25 +00:00
|
|
|
safe_sample if @warmup
|
|
|
|
|
2019-10-16 09:07:51 +00:00
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def run_thread
|
2017-09-04 20:14:54 +00:00
|
|
|
sleep(sleep_interval)
|
|
|
|
while running
|
|
|
|
safe_sample
|
2017-09-04 23:34:28 +00:00
|
|
|
sleep(sleep_interval)
|
2017-09-04 20:14:54 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def stop_working
|
|
|
|
@running = false
|
|
|
|
end
|
2017-08-10 14:18:37 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2017-09-04 20:14:54 +00:00
|
|
|
end
|