Log warning and do nothing on double binding to same registry

micrometer-metrics · Feb 5, 2025 · 66368f4 · 66368f4
1 parent cd4b6bf
commit 66368f4
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/...ometer-core/src/main/java/io/micrometer/core/instrument/binder/logging/Log4j2Metrics.java b/...ometer-core/src/main/java/io/micrometer/core/instrument/binder/logging/Log4j2Metrics.java
@@ -17,6 +17,8 @@
 
 import io.micrometer.common.lang.NonNullApi;
 import io.micrometer.common.lang.NonNullFields;
+import io.micrometer.common.util.internal.logging.InternalLogger;
+import io.micrometer.common.util.internal.logging.InternalLoggerFactory;
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tag;
@@ -60,6 +62,8 @@ public class Log4j2Metrics implements MeterBinder, AutoCloseable {
 
     private static final String METER_DESCRIPTION = "Number of log events";
 
+    private static final InternalLogger logger = InternalLoggerFactory.getInstance(Log4j2Metrics.class);
+
     private final Iterable<Tag> tags;
 
     private final LoggerContext loggerContext;
@@ -83,6 +87,10 @@ public Log4j2Metrics(Iterable<Tag> tags, LoggerContext loggerContext) {
 
     @Override
     public void bindTo(MeterRegistry registry) {
+        if (metricsFilters.containsKey(registry)) {
+            logger.warn("This Log4j2Metrics instance has already been bound to the registry {}", registry);
+            return;
+        }
         Configuration configuration = loggerContext.getConfiguration();
         registerMetricsFilter(configuration, registry);
         loggerContext.updateLoggers(configuration);

diff --git a/...er-core/src/test/java/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java b/...er-core/src/test/java/io/micrometer/core/instrument/binder/logging/Log4j2MetricsTest.java
@@ -341,4 +341,31 @@ void shouldNotRebindMetricsIfBinderIsClosed() {
         assertThat(registry.get("log4j2.events").tags("level", "error").counter().count()).isEqualTo(1);
     }
 
+    @Test
+    void bindingTwiceToSameRegistry_doesNotDoubleCount() {
+        LoggerContext context = new LoggerContext("test");
+        Logger logger = context.getLogger("com.test");
+
+        try (Log4j2Metrics metrics = new Log4j2Metrics(emptyList(), context)) {
+            // binding twice
+            metrics.bindTo(registry);
+            metrics.bindTo(registry);
+
+            logger.error("first");
+
+            assertThat(registry.get("log4j2.events").tags("level", "error").counter().count()).isEqualTo(1);
+
+            context.reconfigure();
+
+            logger.error("second");
+            assertThat(registry.get("log4j2.events").tags("level", "error").counter().count()).isEqualTo(2);
+        }
+
+        // no additional events should be counted now
+        context.reconfigure();
+
+        logger.error("third");
+        assertThat(registry.get("log4j2.events").tags("level", "error").counter().count()).isEqualTo(2);
+    }
+
 }