[英]Unittests for prometheus gauge metrics
Here is my metrics code:这是我的指标代码:
from prometheus_client import Gauge
probe = Gauge('probe_success', '1 - probe success, 0 - probe failure'
['probe_type', 'target', 'timeout', 'service', 'namespace', 'reason'])
If request to the address is successful the value in the end is 1, if some error occurs the value is 0.如果对地址的请求成功,则最后的值为1,如果发生错误,则值为0。
def probe_success(probe_type, target, timeout, service, namespace, reason, value):
probe.labels(probe_type, target, timeout, service, namespace, reason).set(value)
And this is how my metrics look like:这就是我的指标的样子:
probe_success{namespace="test",probe_type="http",reason="MissingSchema",service="servicename",target="ddress-test1",timeout="5"} 0.0
probe_success{namespace="test",probe_type="http",reason="ConnectionError",service="servicename",target="http://address-test2",timeout="10"} 0.0
probe_success{namespace="test-2",probe_type="http",reason="",service="servicename",target="https://www.google.com",timeout="5"} 1.0
So how could I test these metrics.那么我该如何测试这些指标。 I read about REGISTRY.get_sample_value but I didn't see how can I use it on gauge set method.
我阅读了有关 REGISTRY.get_sample_value 的信息,但我没有看到如何在量规设置方法上使用它。 In general I don't have idea how to build appropriate test cases.
一般来说,我不知道如何构建适当的测试用例。 If anyone has suggestions I will be pleased to read them.
如果有人有建议,我会很高兴阅读它们。
Here is my solution:这是我的解决方案:
from prometheus_client import REGISTRY
from utils.metrics import probe_success
def test_probe_success_metric_when_the_probe_fails():
# calling the metrics function, passing the needed parameters
# setting the gauges value to be equal to 0 (which means 'False', by default it is 1 'True')
probe_success(
'http',
'http://127.0.0.1:8000/',
1,
'test_service',
'test_namespace',
'Timeout',
0,
)
# searching in prometheus_client REGISTRY by metrics function name, and certain arguments (passed above)
after = REGISTRY.get_sample_value(
'probe_success',
{
'probe_type': 'http',
'target': 'http://127.0.0.1:8000/',
'timeout': '1',
'service': 'test_service',
'namespace': 'test_namespace',
'reason': 'Timeout',
},
)
# assert whether found gauge value of after is equal to 0.0 (the value which we passed above)
assert 0.0 == after
# Here the procedure is the same as above, but with the difference that here the gauge value is set to 1 'True'.
def test_probe_success_metric_when_the_probe_success():
probe_success(
'http', 'http://127.0.0.1:8000/', 1, 'test_service',
'test_namespace', '', 1
)
after = REGISTRY.get_sample_value(
'probe_success',
{
'probe_type': 'http',
'target': 'http://127.0.0.1:8000/',
'timeout': '1',
'service': 'test_service',
'namespace': 'test_namespace',
'reason': '',
},
)
assert 1.0 == after
Here is an example with explanation but with Counter metrics: https://www.robustperception.io/how-to-unit-test-prometheus-instrumentation这是一个带有解释但带有计数器指标的示例: https ://www.robustperception.io/how-to-unit-test-prometheus-instrumentation
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.