def test_basic_custom_metrics(metric_mock):
# Make sure each of metric works as expected.
# -- Counter --
count = Counter("count", tag_keys=("a", ))
with pytest.raises(TypeError):
count.inc("hi")
with pytest.raises(ValueError):
count.inc(0)
with pytest.raises(ValueError):
count.inc(-1)
count._metric = metric_mock
count.inc(1, {"a": "1"})
metric_mock.record.assert_called_with(1, tags={"a": "1"})
# -- Gauge --
gauge = Gauge("gauge", description="gauge")
gauge._metric = metric_mock
gauge.record(4)
metric_mock.record.assert_called_with(4, tags={})
# -- Histogram
histogram = Histogram(
"hist", description="hist", boundaries=[1.0, 3.0], tag_keys=("a", "b"))
histogram._metric = metric_mock
tags = {"a": "10", "b": "b"}
histogram.observe(8, tags=tags)
metric_mock.record.assert_called_with(8, tags=tags)
class MyActor:
def __init__(self, name):
self._curr_count = 0
self.counter = Counter(
"num_requests",
description="Number of requests processed by the actor.",
tag_keys=("actor_name", ))
self.counter.set_default_tags({"actor_name": name})
self.gauge = Gauge(
"curr_count",
description="Current count held by the actor. Goes up and down.",
tag_keys=("actor_name", ))
self.gauge.set_default_tags({"actor_name": name})
self.histogram = Histogram("request_latency",
description="Latencies of requests in ms.",
boundaries=[0.1, 1],
tag_keys=("actor_name", ))
self.histogram.set_default_tags({"actor_name": name})
def process_request(self, num):
start = time.time()
self._curr_count += num
# Increment the total request count.
self.counter.inc()
# Update the gauge to the new value.
self.gauge.set(self._curr_count)
# Record the latency for this request in ms.
self.histogram.observe(1000 * (time.time() - start))
return self._curr_count
async def ping(self):
histogram = Histogram("test_histogram",
description="desc",
boundaries=[0.1, 1.6])
histogram = ray.get(ray.put(histogram)) # Test serialization.
histogram.observe(1.5)
ray.get(worker_should_exit.wait.remote())
def test_custom_metrics_default_tags(metric_mock):
histogram = Histogram("hist",
description="hist",
boundaries=[1.0, 2.0],
tag_keys=("a", "b")).set_default_tags({"b": "b"})
histogram._metric = metric_mock
# Check specifying non-default tags.
histogram.observe(10, tags={"a": "a"})
metric_mock.record.assert_called_with(10, tags={"a": "a", "b": "b"})
# Check overriding default tags.
tags = {"a": "10", "b": "c"}
histogram.observe(8, tags=tags)
metric_mock.record.assert_called_with(8, tags=tags)
