Support message supplier in WarnThenDebugLogger (#3424)

This commit also updates to use its supplier variants where beneficial.

Author: izeye

implementations/micrometer-registry-cloudwatch/src/main/java/io/micrometer/cloudwatch/CloudWatchMeterRegistry.java

@@ -301,7 +301,8 @@ private List<Dimension> toDimensions(List<Tag> tags) {
 
         private boolean isAcceptableTag(Tag tag) {
             if (StringUtils.isBlank(tag.getValue())) {
-                warnThenDebugLogger.log("Dropping a tag with key '" + tag.getKey() + "' because its value is blank.");
+                warnThenDebugLogger
+                        .log(() -> "Dropping a tag with key '" + tag.getKey() + "' because its value is blank.");
                 return false;
             }
             return true;

implementations/micrometer-registry-cloudwatch2/src/main/java/io/micrometer/cloudwatch2/CloudWatchMeterRegistry.java

@@ -295,7 +295,8 @@ private List<Dimension> toDimensions(List<Tag> tags) {
 
         private boolean isAcceptableTag(Tag tag) {
             if (StringUtils.isBlank(tag.getValue())) {
-                warnThenDebugLogger.log("Dropping a tag with key '" + tag.getKey() + "' because its value is blank.");
+                warnThenDebugLogger
+                        .log(() -> "Dropping a tag with key '" + tag.getKey() + "' because its value is blank.");
                 return false;
             }
             return true;

implementations/micrometer-registry-dynatrace/src/main/java/io/micrometer/dynatrace/v1/DynatraceNamingConventionV1.java

@@ -64,7 +64,7 @@ private String sanitizeName(String name) {
         }
         String sanitized = NAME_CLEANUP_PATTERN.matcher(name).replaceAll("_");
         if (LEADING_NUMERIC_PATTERN.matcher(sanitized).find()) {
-            logger.log("'" + sanitized + "' (original name: '" + name + "') is not a valid meter name. "
+            logger.log(() -> "'" + sanitized + "' (original name: '" + name + "') is not a valid meter name. "
                     + "Dynatrace doesn't allow leading numeric characters after non-alphabets. "
                     + "Please rename it to conform to the constraints. "
                     + "If it comes from a third party, please use MeterFilter to rename it.");

implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxNamingConvention.java

@@ -89,7 +89,8 @@ public String tagKey(String key) {
             conventionKey = "a" + conventionKey;
         }
         if (PATTERN_TAG_KEY_DENYLISTED_PREFIX.matcher(conventionKey).matches()) {
-            logger.log("'" + conventionKey + "' (original name: '" + key + "') is not a valid tag key. "
+            String finalConventionKey = conventionKey;
+            logger.log(() -> "'" + finalConventionKey + "' (original name: '" + key + "') is not a valid tag key. "
                     + "Must not start with any of these prefixes: aws_, gcp_, or azure_. "
                     + "Please rename it to conform to the constraints. "
                     + "If it comes from a third party, please use MeterFilter to rename it.");

implementations/micrometer-registry-statsd/src/main/java/io/micrometer/statsd/StatsdMeterRegistry.java

@@ -182,7 +182,7 @@ void poll() {
                 pollableMeter.getValue().poll();
             }
             catch (RuntimeException e) {
-                warnThenDebugLogger.log("Failed to poll a meter '" + pollableMeter.getKey().getName() + "'.", e);
+                warnThenDebugLogger.log(() -> "Failed to poll a meter '" + pollableMeter.getKey().getName() + "'.", e);
             }
         }
     }

micrometer-core/src/main/java/io/micrometer/core/instrument/binder/kafka/KafkaMetrics.java

@@ -227,7 +227,7 @@ else if (tags.size() == meterTagsWithCommonTags.size())
                     catch (Exception ex) {
                         String message = ex.getMessage();
                         if (message != null && message.contains("Prometheus requires")) {
-                            warnThenDebugLogger.log("Failed to bind meter: " + meterName + " " + tags
+                            warnThenDebugLogger.log(() -> "Failed to bind meter: " + meterName + " " + tags
                                     + ". However, this could happen and might be restored in the next refresh.");
                         }
                         else {

micrometer-core/src/main/java/io/micrometer/core/instrument/dropwizard/DropwizardMeterRegistry.java

@@ -95,7 +95,7 @@ protected <T> io.micrometer.core.instrument.Gauge newGauge(Meter.Id id, @Nullabl
                     return valueFunction.applyAsDouble(obj2);
                 }
                 catch (Throwable ex) {
-                    logger.log("Failed to apply the value function for the gauge '" + id.getName() + "'.", ex);
+                    logger.log(() -> "Failed to apply the value function for the gauge '" + id.getName() + "'.", ex);
                 }
             }
             return nullGaugeValue();

micrometer-core/src/main/java/io/micrometer/core/instrument/internal/DefaultGauge.java

@@ -53,7 +53,7 @@ public double value() {
                 return value.applyAsDouble(obj);
             }
             catch (Throwable ex) {
-                logger.log("Failed to apply the value function for the gauge '" + getId().getName() + "'.", ex);
+                logger.log(() -> "Failed to apply the value function for the gauge '" + getId().getName() + "'.", ex);
             }
         }
         return Double.NaN;

micrometer-core/src/main/java/io/micrometer/core/util/internal/logging/WarnThenDebugLogger.java

@@ -16,6 +16,7 @@
 package io.micrometer.core.util.internal.logging;
 
 import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.function.Supplier;
 
 /**
  * {@link InternalLogger} which logs at warn level at first and then logs at debug level
@@ -35,16 +36,19 @@ public WarnThenDebugLogger(Class<?> clazz) {
     }
 
     public void log(String message, Throwable ex) {
-        InternalLogLevel level;
-        String finalMessage;
         if (this.warnLogged.compareAndSet(false, true)) {
-            level = InternalLogLevel.WARN;
-            finalMessage = message + " Note that subsequent logs will be logged at debug level.";
+            log(InternalLogLevel.WARN, getWarnMessage(message), ex);
         }
         else {
-            level = InternalLogLevel.DEBUG;
-            finalMessage = message;
+            log(InternalLogLevel.DEBUG, message, ex);
         }
+    }
+
+    private String getWarnMessage(String message) {
+        return message + " Note that subsequent logs will be logged at debug level.";
+    }
+
+    private void log(InternalLogLevel level, String finalMessage, Throwable ex) {
         if (ex != null) {
             this.logger.log(level, finalMessage, ex);
         }
@@ -57,4 +61,19 @@ public void log(String message) {
         log(message, null);
     }
 
+    public void log(Supplier<String> messageSupplier, Throwable ex) {
+        if (this.warnLogged.compareAndSet(false, true)) {
+            log(InternalLogLevel.WARN, getWarnMessage(messageSupplier.get()), ex);
+        }
+        else {
+            if (this.logger.isDebugEnabled()) {
+                log(InternalLogLevel.DEBUG, messageSupplier.get(), ex);
+            }
+        }
+    }
+
+    public void log(Supplier<String> messageSupplier) {
+        log(messageSupplier, null);
+    }
+
 }