def __init__(self, name, help_text, const_labels=None):
self.name = name
self.help_text = help_text
self.const_labels = const_labels
if const_labels:
self._label_names_correct(const_labels)
self.const_labels = const_labels
# This is a map that contains all the metrics
# This variable should be syncronized
self.values = MetricDict()
def test_override(self):
metrics = MetricDict()
key = {'a': 1}
for i in range(100):
metrics[key] = i
self.assertEqual(i, metrics[key])
self.assertEqual(1, len(metrics))
def test_empty_key(self):
metrics = MetricDict()
iterations = 100
for i in range(iterations):
metrics[None] = i
self.assertEqual(metrics[None], i)
# Last check (different empty)
self.assertEqual(iterations-1, metrics[""])
self.assertEqual(iterations-1, metrics[{}])
def test_similar(self):
metrics = MetricDict()
data = (
({'d': 4, 'e': 5, 'f': 6}, 3000),
({'e': 5, 'd': 4, 'f': 6}, 4000),
({'d': 4, 'f': 6, 'e': 5}, 5000),
)
for i in data:
metrics[i[0]] = i[1]
self.assertEqual(1, len(metrics))
def test_set(self):
metrics = MetricDict()
data = (
({'a': 1}, 1000),
({'b': 2, 'c': 3}, 2000),
({'d': 4, 'e': 5, 'f': 6}, 3000),
)
for i in data:
metrics[i[0]] = i[1]
self.assertEqual(len(data), len(metrics))
def test_get(self):
metrics = MetricDict()
data = (
({'a': 1}, 1000),
({'b': 2, 'c': 3}, 2000),
({'d': 4, 'e': 5, 'f': 6}, 3000),
)
for i in data:
metrics[i[0]] = i[1]
for i in data:
self.assertEqual(i[1], metrics[i[0]])
def test_delete(self):
metrics = MetricDict()
data = (
({'d': 4, 'e': 5, 'f': 6}, 3000),
({'e': 5, 'd': 4, 'f': 6}, 4000),
({'d': 4, 'f': 6, 'e': 5}, 5000),
({'d': 41, 'f': 61, 'e': 51}, 6000),
({'d': 41, 'e': 51, 'f': 61}, 7000),
({'f': 61, 'e': 51, 'd': 41}, 8000),
)
for i in data:
metrics[i[0]] = i[1]
del metrics[i[0]]
self.assertEqual(1, len(metrics))
def test_all(self):
metrics = MetricDict()
data = (
({'d': 4, 'e': 5, 'f': 6}, 3000),
({'e': 5, 'd': 4, 'f': 6}, 4000),
({'d': 4, 'f': 6, 'e': 5}, 5000),
({'d': 41, 'f': 61, 'e': 51}, 6000),
({'d': 41, 'e': 51, 'f': 61}, 7000),
({'f': 61, 'e': 51, 'd': 41}, 8000),
)
for i in data:
metrics[i[0]] = i[1]
self.assertEqual(2, len(metrics))
self.assertEqual(5000, metrics[{'d': 4, 'e': 5, 'f': 6}])
self.assertEqual(8000, metrics[{'d': 41, 'f': 61, 'e': 51}])
def test_access_by_str(self):
label = {'b': 2, 'c': 3, 'a': 1}
access_key = '{"a": 1, "b": 2, "c": 3}'
bad_access_key = '{"b": 2, "c": 3, "a": 1}'
value = 100
metrics = MetricDict()
metrics[label] = 100
# Wrong string
with self.assertRaises(TypeError) as context:
metrics['dasdasd']
self.assertEqual('Only accepts dicts as keys', str(context.exception))
# Access ok with string
self.assertEqual(value, metrics[access_key])
# Access ok but wrong key by order
with self.assertRaises(KeyError) as context:
metrics[bad_access_key]
self.assertEqual("'{0}'".format(bad_access_key),
str(context.exception))
def test_bad_keys(self):
with self.assertRaises(TypeError) as context:
metrics = MetricDict()
metrics['not_valid'] = "value"
self.assertEqual('Only accepts dicts as keys', str(context.exception))
class Collector(object):
"""Collector is the base class for all the collectors/metrics"""
REPR_STR = "untyped"
def __init__(self, name, help_text, const_labels=None):
self.name = name
self.help_text = help_text
self.const_labels = const_labels
if const_labels:
self._label_names_correct(const_labels)
self.const_labels = const_labels
# This is a map that contains all the metrics
# This variable should be syncronized
self.values = MetricDict()
def set_value(self, labels, value):
""" Sets a value in the container"""
if labels:
self._label_names_correct(labels)
with mutex:
self.values[labels] = value
def get_value(self, labels):
""" Gets a value in the container, exception if isn't present"""
with mutex:
return self.values[labels]
def get(self, labels):
"""Handy alias"""
return self.get_value(labels)
def _label_names_correct(self, labels):
"""Raise exception (ValueError) if labels not correct"""
for k, v in labels.items():
# Check reserved labels
if k in RESTRICTED_LABELS_NAMES:
raise ValueError("Labels not correct")
# Check prefixes
if any(k.startswith(i) for i in RESTRICTED_LABELS_PREFIXES):
raise ValueError("Labels not correct")
return True
def get_all(self):
""" Returns a list populated by tuples of 2 elements, first one is
a dict with all the labels and the second elemnt is the value
of the metric itself
"""
with mutex:
items = self.values.items()
result = []
for k, v in items:
# Check if is a single value dict (custom empty key)
if not k or k == MetricDict.EMPTY_KEY:
key = None
else:
key = decoder.decode(k)
result.append((key, self.get(k)))
return result