In Spring Boot, how to reset the metrics registry before each test?

Question

I have tests and want to make assertions against micrometer metrics, but the tests run in random order so I want to reset or clear all the micrometer metrics before each test so my assertion are always correct.

score 9 · Answer 1 · edited Jun 13 '20 at 20:04

9

It depends on the Meter registry used. If you are using a SimpleMeterRegistry you could do:

registry.getMeters().forEach((meter) -> registry.remove(meter))

edited Jun 13 '20 at 20:04

rogerdpack

62,887
36
269
388

answered Aug 28 '19 at 06:31

checketts

14,167
10
53
82

3

Same but more concise and works for any MeterRegistry: `registry.clear()`. Actually removes the meters rather than resets their values. – David Soroko Mar 07 '21 at 13:21
Turn this into a separate answer and I'll be happy to upvote. – Stefan Haberl Sep 02 '21 at 08:12

score 8 · Answer 2 · answered Feb 16 '22 at 16:15

8

You can use clear() method

registry.clear();

answered Feb 16 '22 at 16:15

mrek

1,655
1
21
34

score 0 · Answer 3 · answered May 07 '21 at 02:04

You should try to mock meter registry, since they are monitoring and should not affect your business logic and used for alerting. In case that doesn't help:

for gauge you can reset values

AtomicInteger myGauge = meterRegistry.gauge("numberGauge", new AtomicInteger(0));
myGauge.set(0);

for counter, reinitialize,

counter = meterRegistry.counter(counter.toString());

Reference: https://micrometer.io/docs/concepts#_manually_incrementingdecrementing_a_gauge

meterRegistry.counter() wont reinitialize counter, it creates or return existing counter — voipp, Jul 28 '21 at 18:00

In Spring Boot, how to reset the metrics registry before each test?

3 Answers3