Add publishAverage config and conditional avg publishing for timers/summaries

Signed-off-by: jaxxnitt <[email protected]>

Author: dependabot[bot]

implementations/micrometer-registry-datadog/src/main/java/io/micrometer/datadog/DatadogConfig.java

@@ -76,4 +76,8 @@ default Validated<?> validate() {
                 checkRequired("uri", DatadogConfig::uri));
     }
 
+    default boolean publishAverage() {
+        return getBoolean(this, "publishAverage").orElse(true);
+    }
+
 }

implementations/micrometer-registry-datadog/src/main/java/io/micrometer/datadog/DatadogMeterRegistry.java

@@ -34,6 +34,7 @@
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
+import java.util.Objects;
 
 import static io.micrometer.core.instrument.util.StringEscapeUtils.escapeJson;
 import static java.util.stream.Collectors.joining;
@@ -160,29 +161,44 @@ private Stream<String> writeTimer(FunctionTimer timer, Map<String, DatadogMetric
         Meter.Id id = timer.getId();
 
         addToMetadataList(metadata, id, "count", Statistic.COUNT, "occurrence");
-        addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+
+        if (config.publishAverage()) {
+            addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+        }
+
         addToMetadataList(metadata, id, "sum", Statistic.TOTAL_TIME, null);
 
         // we can't know anything about max and percentiles originating from a function
         // timer
         return Stream.of(writeMetric(id, "count", wallTime, timer.count(), Statistic.COUNT, "occurrence"),
-                writeMetric(id, "avg", wallTime, timer.mean(getBaseTimeUnit()), Statistic.VALUE, null),
-                writeMetric(id, "sum", wallTime, timer.totalTime(getBaseTimeUnit()), Statistic.TOTAL_TIME, null));
+
+                config.publishAverage()
+                        ? writeMetric(id, "avg", wallTime, timer.mean(getBaseTimeUnit()), Statistic.VALUE, null) : null,
+
+                writeMetric(id, "sum", wallTime, timer.totalTime(getBaseTimeUnit()), Statistic.TOTAL_TIME, null))
+            // filter out null avg when disabled
+            .filter(Objects::nonNull);
     }
 
     private Stream<String> writeTimer(Timer timer, Map<String, DatadogMetricMetadata> metadata) {
         final long wallTime = clock.wallTime();
         final Stream.Builder<String> metrics = Stream.builder();
 
         Meter.Id id = timer.getId();
-        metrics.add(writeMetric(id, "sum", wallTime, timer.totalTime(getBaseTimeUnit()), Statistic.TOTAL_TIME, null));
-        metrics.add(writeMetric(id, "count", wallTime, (double) timer.count(), Statistic.COUNT, "occurrence"));
-        metrics.add(writeMetric(id, "avg", wallTime, timer.mean(getBaseTimeUnit()), Statistic.VALUE, null));
-        metrics.add(writeMetric(id, "max", wallTime, timer.max(getBaseTimeUnit()), Statistic.MAX, null));
 
+        metrics.add(writeMetric(id, "sum", wallTime, timer.totalTime(getBaseTimeUnit()), Statistic.TOTAL_TIME, null));
         addToMetadataList(metadata, id, "sum", Statistic.TOTAL_TIME, null);
+
+        metrics.add(writeMetric(id, "count", wallTime, (double) timer.count(), Statistic.COUNT, "occurrence"));
         addToMetadataList(metadata, id, "count", Statistic.COUNT, "occurrence");
-        addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+
+        // publish avg only when enabled
+        if (config.publishAverage()) {
+            metrics.add(writeMetric(id, "avg", wallTime, timer.mean(getBaseTimeUnit()), Statistic.VALUE, null));
+            addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+        }
+
+        metrics.add(writeMetric(id, "max", wallTime, timer.max(getBaseTimeUnit()), Statistic.MAX, null));
         addToMetadataList(metadata, id, "max", Statistic.MAX, null);
 
         return metrics.build();
@@ -193,14 +209,20 @@ private Stream<String> writeSummary(DistributionSummary summary, Map<String, Dat
         final Stream.Builder<String> metrics = Stream.builder();
 
         Meter.Id id = summary.getId();
-        metrics.add(writeMetric(id, "sum", wallTime, summary.totalAmount(), Statistic.TOTAL, null));
-        metrics.add(writeMetric(id, "count", wallTime, (double) summary.count(), Statistic.COUNT, "occurrence"));
-        metrics.add(writeMetric(id, "avg", wallTime, summary.mean(), Statistic.VALUE, null));
-        metrics.add(writeMetric(id, "max", wallTime, summary.max(), Statistic.MAX, null));
 
+        metrics.add(writeMetric(id, "sum", wallTime, summary.totalAmount(), Statistic.TOTAL, null));
         addToMetadataList(metadata, id, "sum", Statistic.TOTAL, null);
+
+        metrics.add(writeMetric(id, "count", wallTime, (double) summary.count(), Statistic.COUNT, "occurrence"));
         addToMetadataList(metadata, id, "count", Statistic.COUNT, "occurrence");
-        addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+
+        // avg (only when enabled)
+        if (config.publishAverage()) {
+            metrics.add(writeMetric(id, "avg", wallTime, summary.mean(), Statistic.VALUE, null));
+            addToMetadataList(metadata, id, "avg", Statistic.VALUE, null);
+        }
+
+        metrics.add(writeMetric(id, "max", wallTime, summary.max(), Statistic.MAX, null));
         addToMetadataList(metadata, id, "max", Statistic.MAX, null);
 
         return metrics.build();