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
|
# frozen_string_literal: true
# Instrumentation for cache efficiency metrics
module Gitlab
module Cache
class Metrics
DEFAULT_BUCKETS = [0, 1, 5].freeze
VALID_BACKING_RESOURCES = [:cpu, :database, :gitaly, :memory, :unknown].freeze
DEFAULT_BACKING_RESOURCE = :unknown
def initialize(
caller_id:,
cache_identifier:,
feature_category: ::Gitlab::FeatureCategories::FEATURE_CATEGORY_DEFAULT,
backing_resource: DEFAULT_BACKING_RESOURCE
)
@caller_id = caller_id
@cache_identifier = cache_identifier
@feature_category = Gitlab::FeatureCategories.default.get!(feature_category)
@backing_resource = fetch_backing_resource!(backing_resource)
end
# Increase cache hit counter
#
def increment_cache_hit
counter.increment(labels.merge(cache_hit: true))
end
# Increase cache miss counter
#
def increment_cache_miss
counter.increment(labels.merge(cache_hit: false))
end
# Measure the duration of cacheable action
#
# @example
# observe_cache_generation do
# cacheable_action
# end
#
def observe_cache_generation(&block)
real_start = Gitlab::Metrics::System.monotonic_time
value = yield
histogram.observe({}, Gitlab::Metrics::System.monotonic_time - real_start)
value
end
private
attr_reader :caller_id, :cache_identifier, :feature_category, :backing_resource
def counter
@counter ||= Gitlab::Metrics.counter(:redis_hit_miss_operations_total, "Hit/miss Redis cache counter")
end
def histogram
@histogram ||= Gitlab::Metrics.histogram(
:redis_cache_generation_duration_seconds,
'Duration of Redis cache generation',
labels,
DEFAULT_BUCKETS
)
end
def labels
@labels ||= {
caller_id: caller_id,
cache_identifier: cache_identifier,
feature_category: feature_category,
backing_resource: backing_resource
}
end
def fetch_backing_resource!(resource)
return resource if VALID_BACKING_RESOURCES.include?(resource)
raise "Unknown backing resource: #{resource}" if Gitlab.dev_or_test_env?
DEFAULT_BACKING_RESOURCE
end
end
end
end
|
