Skip to content

Optimize label handling with predefined label keys in counter/gauge #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Optimize label handling with predefined label keys in counter/gauge #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions metrics/api.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,16 @@ local function clear()
registry:clear()
end

local function counter(name, help, metainfo)
checks('string', '?string', '?table')
local function counter(name, help, metainfo, label_keys)
checks('string', '?string', '?table', '?table')

return registry:find_or_create(Counter, name, help, metainfo)
return registry:find_or_create(Counter, name, help, metainfo, label_keys)
end

local function gauge(name, help, metainfo)
checks('string', '?string', '?table')
local function gauge(name, help, metainfo, label_keys)
checks('string', '?string', '?table', '?table')

return registry:find_or_create(Gauge, name, help, metainfo)
return registry:find_or_create(Gauge, name, help, metainfo, label_keys)
end

local function histogram(name, help, buckets, metainfo)
Expand Down
31 changes: 22 additions & 9 deletions metrics/collectors/shared.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ function Shared:new_class(kind, method_names)
return setmetatable(class, {__index = methods})
end

function Shared:new(name, help, metainfo)
function Shared:new(name, help, metainfo, label_keys)
metainfo = table.copy(metainfo) or {}

if not name then
Expand All @@ -35,6 +35,7 @@ function Shared:new(name, help, metainfo)
help = help or "",
observations = {},
label_pairs = {},
label_keys = label_keys,
metainfo = metainfo,
}, self)
end
Expand All @@ -43,21 +44,33 @@ function Shared:set_registry(registry)
self.registry = registry
end

function Shared.make_key(label_pairs)
function Shared.make_key(label_pairs, label_keys)
if type(label_pairs) ~= 'table' then
return ""
end

local parts = {}
for k, v in pairs(label_pairs) do
table.insert(parts, k .. '\t' .. v)
if label_keys ~= nil then
for _, label_key in ipairs(label_keys) do
local label_value = label_pairs[label_key]
if label_value == nil then
error(string.format("Label key '%s' is missing", label_key))
end
table.insert(parts, label_value)
end
else
for k, v in pairs(label_pairs) do
table.insert(parts, k .. '\t' .. v)
end
table.sort(parts)
end
table.sort(parts)

return table.concat(parts, '\t')
end

function Shared:remove(label_pairs)
assert(label_pairs, 'label pairs is a required parameter')
local key = self.make_key(label_pairs)
local key = self.make_key(label_pairs, self.label_keys)
self.observations[key] = nil
self.label_pairs[key] = nil
end
Expand All @@ -67,7 +80,7 @@ function Shared:set(num, label_pairs)
error("Collector set value should be a number")
end
num = num or 0
local key = self.make_key(label_pairs)
local key = self.make_key(label_pairs, self.label_keys)
self.observations[key] = num
self.label_pairs[key] = label_pairs or {}
end
Expand All @@ -77,7 +90,7 @@ function Shared:inc(num, label_pairs)
error("Collector increment should be a number")
end
num = num or 1
local key = self.make_key(label_pairs)
local key = self.make_key(label_pairs, self.label_keys)
local old_value = self.observations[key] or 0
self.observations[key] = old_value + num
self.label_pairs[key] = label_pairs or {}
Expand All @@ -88,7 +101,7 @@ function Shared:dec(num, label_pairs)
error("Collector decrement should be a number")
end
num = num or 1
local key = self.make_key(label_pairs)
local key = self.make_key(label_pairs, self.label_keys)
local old_value = self.observations[key] or 0
self.observations[key] = old_value - num
self.label_pairs[key] = label_pairs or {}
Expand Down
47 changes: 47 additions & 0 deletions test/collectors/counter_test.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,50 @@ g.test_metainfo_immutable = function()
metainfo['my_useful_info'] = 'there'
t.assert_equals(c.metainfo, {my_useful_info = 'here'})
end

g.test_counter_with_fixed_labels = function()
local fixed_labels = {'label1', 'label2'}
local counter = metrics.counter('counter_with_labels', nil, {}, fixed_labels)

counter:inc(1, {label1 = 1, label2 = 'text'})
utils.assert_observations(counter:collect(), {
{'counter_with_labels', 1, {label1 = 1, label2 = 'text'}},
})

counter:inc(5, {label2 = 'text', label1 = 2})
utils.assert_observations(counter:collect(), {
{'counter_with_labels', 1, {label1 = 1, label2 = 'text'}},
{'counter_with_labels', 5, {label1 = 2, label2 = 'text'}},
})

counter:reset({label1 = 1, label2 = 'text'})
utils.assert_observations(counter:collect(), {
{'counter_with_labels', 0, {label1 = 1, label2 = 'text'}},
{'counter_with_labels', 5, {label1 = 2, label2 = 'text'}},
})

counter:remove({label1 = 2, label2 = 'text'})
utils.assert_observations(counter:collect(), {
{'counter_with_labels', 0, {label1 = 1, label2 = 'text'}},
})
end

g.test_counter_missing_label = function()
local fixed_labels = {'label1', 'label2'}
local counter = metrics.counter('counter_with_labels', nil, {}, fixed_labels)

counter:inc(42, {label1 = 1, label2 = 'text'})
utils.assert_observations(counter:collect(), {
{'counter_with_labels', 42, {label1 = 1, label2 = 'text'}},
})

local function assert_missing_label_error(fun, ...)
t.assert_error_msg_contains(
"is missing",
fun, counter, ...)
end

assert_missing_label_error(counter.inc, 1, {label1 = 1})
assert_missing_label_error(counter.reset, {label2 = 0})
assert_missing_label_error(counter.remove, {})
end
54 changes: 54 additions & 0 deletions test/collectors/gauge_test.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,57 @@ g.test_metainfo_immutable = function()
metainfo['my_useful_info'] = 'there'
t.assert_equals(c.metainfo, {my_useful_info = 'here'})
end

g.test_gauge_with_fixed_labels = function()
local fixed_labels = {'label1', 'label2'}
local gauge = metrics.gauge('gauge_with_labels', nil, {}, fixed_labels)

gauge:set(1, {label1 = 1, label2 = 'text'})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', 1, {label1 = 1, label2 = 'text'}},
})

gauge:set(42, {label2 = 'text', label1 = 100})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', 1, {label1 = 1, label2 = 'text'}},
{'gauge_with_labels', 42, {label1 = 100, label2 = 'text'}},
})

gauge:inc(5, {label2 = 'text', label1 = 100})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', 1, {label1 = 1, label2 = 'text'}},
{'gauge_with_labels', 47, {label1 = 100, label2 = 'text'}},
})

gauge:dec(11, {label1 = 1, label2 = 'text'})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', -10, {label1 = 1, label2 = 'text'}},
{'gauge_with_labels', 47, {label1 = 100, label2 = 'text'}},
})

gauge:remove({label2 = 'text', label1 = 100})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', -10, {label1 = 1, label2 = 'text'}},
})
end

g.test_gauge_missing_label = function()
local fixed_labels = {'label1', 'label2'}
local gauge = metrics.gauge('gauge_with_labels', nil, {}, fixed_labels)

gauge:set(42, {label1 = 1, label2 = 'text'})
utils.assert_observations(gauge:collect(), {
{'gauge_with_labels', 42, {label1 = 1, label2 = 'text'}},
})

local function assert_missing_label_error(fun, ...)
t.assert_error_msg_contains(
"is missing",
fun, gauge, ...)
end

assert_missing_label_error(gauge.inc, 1, {label1 = 1})
assert_missing_label_error(gauge.dec, 2, {label1 = 1})
assert_missing_label_error(gauge.set, 42, {label1 = 1})
assert_missing_label_error(gauge.remove, {})
end