Use different name for StepMeterRegistry thread that polls to roll over

Closes micrometer-metricsgh-3837
izeye · Jun 26, 2023 · 1af154e · 1af154e
1 parent 9415e76
commit 1af154e
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 1 deletion.
diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/step/StepMeterRegistry.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/step/StepMeterRegistry.java
@@ -26,6 +26,7 @@
 import io.micrometer.core.instrument.internal.DefaultLongTaskTimer;
 import io.micrometer.core.instrument.internal.DefaultMeter;
 import io.micrometer.core.instrument.push.PushMeterRegistry;
+import io.micrometer.core.instrument.util.NamedThreadFactory;
 
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -119,7 +120,12 @@ public void start(ThreadFactory threadFactory) {
         super.start(threadFactory);
 
         if (config.enabled()) {
-            this.meterPollingService = Executors.newSingleThreadScheduledExecutor(threadFactory);
+            ThreadFactory pollerThreadFactory = threadFactory;
+            if (threadFactory.getClass() == NamedThreadFactory.class) {
+                pollerThreadFactory = new NamedThreadFactory(
+                        "step-meter-registry-poller-for-" + getClass().getSimpleName());
+            }
+            this.meterPollingService = Executors.newSingleThreadScheduledExecutor(pollerThreadFactory);
 
             this.meterPollingService.scheduleAtFixedRate(this::pollMetersToRollover, getInitialDelay(),
                     config.step().toMillis(), TimeUnit.MILLISECONDS);

diff --git a/micrometer-core/src/test/java/io/micrometer/core/instrument/step/StepMeterRegistryTest.java b/micrometer-core/src/test/java/io/micrometer/core/instrument/step/StepMeterRegistryTest.java
@@ -18,6 +18,7 @@
 import io.micrometer.common.lang.Nullable;
 import io.micrometer.core.Issue;
 import io.micrometer.core.instrument.*;
+import io.micrometer.core.instrument.util.NamedThreadFactory;
 import org.junit.jupiter.api.Test;
 import org.testcontainers.shaded.com.google.common.util.concurrent.AtomicDouble;
 
@@ -450,6 +451,71 @@ public String get(String key) {
         assertThat(publishes.get()).isEqualTo(publishCountBeforeClose);
     }
 
+    @Test
+    void startWithNamedThreadFactoryShouldUseNamedThreadFactoryForPoller() {
+        StepMeterRegistry registry = new CustomStepMeterRegistry();
+        String publisherThreadName = "custom-metrics-publisher";
+        registry.start(new NamedThreadFactory(publisherThreadName));
+        List<String> threadNames = Thread.getAllStackTraces()
+            .keySet()
+            .stream()
+            .map((thread) -> thread.getName())
+            .collect(Collectors.toList());
+        assertThat(threadNames).contains(publisherThreadName)
+            .doesNotContain(publisherThreadName + "-2")
+            .contains("step-meter-registry-poller-for-CustomStepMeterRegistry");
+    }
+
+    @Test
+    void startWithCustomThreadFactoryShouldUseCustomThreadFactoryForPoller() {
+        StepMeterRegistry registry = new CustomStepMeterRegistry();
+        String publisherThreadName = "custom-metrics-publisher";
+        registry.start(new CustomThreadFactory(publisherThreadName));
+        List<String> threadNames = Thread.getAllStackTraces()
+            .keySet()
+            .stream()
+            .map((thread) -> thread.getName())
+            .collect(Collectors.toList());
+        assertThat(threadNames).contains(publisherThreadName)
+            .contains(publisherThreadName + "-2")
+            .doesNotContain("step-meter-registry-poller-for-CustomStepMeterRegistry");
+    }
+
+    static class CustomStepMeterRegistry extends StepMeterRegistry {
+
+        CustomStepMeterRegistry() {
+            super(new StepRegistryConfig() {
+                @Override
+                public String prefix() {
+                    return null;
+                }
+
+                @Override
+                public String get(String key) {
+                    return null;
+                }
+            }, new MockClock());
+        }
+
+        @Override
+        protected void publish() {
+        }
+
+        @Override
+        protected TimeUnit getBaseTimeUnit() {
+            return TimeUnit.SECONDS;
+        }
+
+    }
+
+    static class CustomThreadFactory extends NamedThreadFactory {
+
+        CustomThreadFactory(String prefix) {
+            super(prefix);
+        }
+
+    }
+
     private class MyStepMeterRegistry extends StepMeterRegistry {
 
         Deque<Double> publishedCounterCounts = new ArrayDeque<>();