When logging metrics put em all on one line

Michael Kunze · Michael Kunze · commit b8cc0b6b429a · 2025-01-08T12:01:18.000+01:00
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ If you have any questions please open an issue ticket!
 Add this to your build.gradle.kts
 ```kotlin
 dependencies {
-    implementation("de.inoxio:spring-cloudwatch-metrics:2.0.0")
+    implementation("de.inoxio:spring-cloudwatch-metrics:2.0.1")
 }
 ```
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -12,7 +12,7 @@ plugins {
 }
 
 group = "de.inoxio"
-version = "2.0.0"
+version = "2.0.1"
 description = "A java-spring library to push metrics to cloudwatch"
 
 repositories {
diff --git a/src/main/java/de/inoxio/spring/cloudwatchmetrics/CloudwatchRestDAO.java b/src/main/java/de/inoxio/spring/cloudwatchmetrics/CloudwatchRestDAO.java
@@ -1,7 +1,5 @@
 package de.inoxio.spring.cloudwatchmetrics;
 
-import static java.lang.String.format;
-
 import static org.springframework.util.Assert.notEmpty;
 import static org.springframework.util.Assert.notNull;
 
@@ -11,18 +9,13 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.function.Predicate;
-import java.util.stream.Collectors;
-
-import jakarta.annotation.PostConstruct;
-
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Repository;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-
+import jakarta.annotation.PostConstruct;
 import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient;
 import software.amazon.awssdk.services.cloudwatch.model.DashboardValidationMessage;
 import software.amazon.awssdk.services.cloudwatch.model.Dimension;
@@ -73,22 +66,18 @@ public void addDimension(final DimensionKeyPair... dimensionKeyPairs) {
     public void pushMetrics(final MetricKeyPair... metrics) {
         notEmpty(metrics, "Metrics should at least contain one metric!");
 
-        final var logMessage = new StringBuilder("Push metrics to cloudwatch:");
-
-        final var metricDatums = Arrays.stream(metrics).map(metric -> {
-            logMessage.append(format("%n%25s = %,13.1f", metric.getName(), metric.getValue()));
-            return MetricDatum.builder()
-                              .metricName(metricPrefix + metric.getName())
-                              .unit(StandardUnit.COUNT)
-                              .value(metric.getValue())
-                              .dimensions(dimensions)
-                              .build();
-        }).collect(Collectors.toList());
+        final var metricDatums = Arrays.stream(metrics)
+                .map(metric -> MetricDatum.builder()
+                          .metricName(metricPrefix + metric.getName())
+                          .unit(StandardUnit.COUNT)
+                          .value(metric.getValue())
+                          .dimensions(dimensions)
+                          .build())
+                .toList();
 
         final var request = PutMetricDataRequest.builder().namespace(namespace).metricData(metricDatums).build();
 
-        logInfoMessage(logMessage.toString());
-
+        LOG.info("Push metrics to cloudwatch: {}", (Object) metrics);
         cloudWatchClient.putMetricData(request)
                         .whenComplete((putMetricDataResponse, throwable) -> checkAndThrowError(throwable));
     }
@@ -130,12 +119,8 @@ void updateChangedDashboard(final String annotatedWidgets) {
 
     void handlePutDashboard(final List<DashboardValidationMessage> dashboardValidationMessages, final Throwable throwable) {
         checkAndThrowError(throwable);
-        logInfoMessage("Dashboard annotated");
-        dashboardValidationMessages.forEach(validationMessage -> logInfoMessage("BUT: " + validationMessage.message()));
-    }
-
-    void logInfoMessage(final String message) {
-        LOG.info(message);
+        LOG.info("Dashboard annotated");
+        dashboardValidationMessages.forEach(message -> LOG.info("BUT: {}", message.message()));
     }
 
     String annotateWidgets(final String json) {
diff --git a/src/test/java/de/inoxio/spring/cloudwatchmetrics/CloudwatchRestDAOTest.java b/src/test/java/de/inoxio/spring/cloudwatchmetrics/CloudwatchRestDAOTest.java
@@ -1,7 +1,15 @@
 package de.inoxio.spring.cloudwatchmetrics;
 
+import static de.inoxio.spring.cloudwatchmetrics.AnnotationDTO.AnnotationBuilder.annotionBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.AnnotationsDTO.AnnotationsBuilder.annotationsBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.DimensionKeyPair.DimensionKeyPairBuilder.dimensionKeyPairBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.MetricDTO.MetricBuilder.metricBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.MetricKeyPair.MetricKeyPairBuilder.metricKeyPairBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.PropertyDTO.PropertyBuilder.propertyBuilder;
+import static de.inoxio.spring.cloudwatchmetrics.WidgetDTO.WidgetBuilder.widgetBuilder;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+import static org.assertj.core.api.Assertions.tuple;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.BDDMockito.given;
 import static org.mockito.BDDMockito.then;
@@ -12,33 +20,23 @@
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 
-import static de.inoxio.spring.cloudwatchmetrics.AnnotationDTO.AnnotationBuilder.annotionBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.AnnotationsDTO.AnnotationsBuilder.annotationsBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.DimensionKeyPair.DimensionKeyPairBuilder.dimensionKeyPairBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.MetricDTO.MetricBuilder.metricBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.MetricKeyPair.MetricKeyPairBuilder.metricKeyPairBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.PropertyDTO.PropertyBuilder.propertyBuilder;
-import static de.inoxio.spring.cloudwatchmetrics.WidgetDTO.WidgetBuilder.widgetBuilder;
-
 import java.io.IOException;
 import java.time.ZonedDateTime;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
-
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.assertj.core.api.ThrowableAssert;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
 import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient;
 import software.amazon.awssdk.services.cloudwatch.model.DashboardValidationMessage;
+import software.amazon.awssdk.services.cloudwatch.model.Dimension;
 import software.amazon.awssdk.services.cloudwatch.model.GetDashboardRequest;
 import software.amazon.awssdk.services.cloudwatch.model.GetDashboardResponse;
+import software.amazon.awssdk.services.cloudwatch.model.MetricDatum;
 import software.amazon.awssdk.services.cloudwatch.model.PutDashboardRequest;
 import software.amazon.awssdk.services.cloudwatch.model.PutDashboardResponse;
 import software.amazon.awssdk.services.cloudwatch.model.PutMetricDataRequest;
@@ -52,8 +50,8 @@ void shouldPutMetricsToCloudwatch() {
 
         // given
         final var cloudWatchClient = mock(CloudWatchAsyncClient.class);
-        given(cloudWatchClient.putMetricData(anyPutMetricDataRequest())).willReturn(CompletableFuture.completedFuture(
-                null));
+        given(cloudWatchClient.putMetricData(anyPutMetricDataRequest()))
+                .willReturn(CompletableFuture.completedFuture(null));
         final var cloudwatchRestDAO = new CloudwatchRestDAO(cloudWatchClient, mock(ObjectMapper.class));
         cloudwatchRestDAO.setMetricPrefix("somePrefix");
         cloudwatchRestDAO.setNamespace("someNamespace");
@@ -70,12 +68,14 @@ void shouldPutMetricsToCloudwatch() {
 
         final var metricData = request.metricData();
         assertThat(metricData).as("Size of metric is not one.").hasSize(1);
-        assertThat(metricData.get(0).metricName()).as("Metric name is not correct").isEqualTo("somePrefixsomeMetric");
-        assertThat(metricData.get(0).value()).as("Metric has incorrect value.").isEqualTo(10.0d);
-        assertThat(metricData.get(0).unit()).as("Unit type of metric is incorrect.").isEqualTo(StandardUnit.COUNT);
-
-        final var dimensions = metricData.get(0).dimensions();
-        assertThat(dimensions).as("Size of metric dimensions is incorrect.").hasSize(0);
+        assertThat(metricData).as("Metric name is not correct")
+                .extracting(MetricDatum::metricName).containsExactly("somePrefixsomeMetric");
+        assertThat(metricData).as("Metric has incorrect value.")
+                .extracting(MetricDatum::value).containsExactly(10.0d);
+        assertThat(metricData).as("Unit type of metric is incorrect.")
+                .extracting(MetricDatum::unit).containsExactly(StandardUnit.COUNT);
+        assertThat(metricData).as("Size of metric dimensions is incorrect.")
+                .flatExtracting(MetricDatum::dimensions).hasSize(0);
     }
 
     @Test
@@ -102,14 +102,16 @@ void shouldPutMetricsToCloudwatchWithDimension() {
 
         final var metricData = request.metricData();
         assertThat(metricData).as("Size of metric is not one.").hasSize(1);
-        assertThat(metricData.get(0).metricName()).as("Metric name is not correct").isEqualTo("somePrefixsomeMetric");
-        assertThat(metricData.get(0).value()).as("Metric has incorrect value.").isEqualTo(10.0d);
-        assertThat(metricData.get(0).unit()).as("Unit type of metric is incorrect.").isEqualTo(StandardUnit.COUNT);
-
-        final var dimensions = metricData.get(0).dimensions();
-        assertThat(dimensions).as("Size of metric dimensions is incorrect.").hasSize(1);
-        assertThat(dimensions.get(0).name()).as("Dimension name of metric is incorrect.").isEqualTo("someDimension");
-        assertThat(dimensions.get(0).value()).as("Dimension value of metric is incorrect.").isEqualTo("dimensionValue");
+        assertThat(metricData).as("Metric name is not correct")
+                .extracting(MetricDatum::metricName).containsExactly("somePrefixsomeMetric");
+        assertThat(metricData).as("Metric has incorrect value.")
+                .extracting(MetricDatum::value).containsExactly(10.0d);
+        assertThat(metricData).as("Unit type of metric is incorrect.")
+                .extracting(MetricDatum::unit).containsExactly(StandardUnit.COUNT);
+        assertThat(metricData).as("Dimonsion name and value is incorrect.")
+                .flatExtracting(MetricDatum::dimensions)
+                .extracting(Dimension::name, Dimension::value)
+                .containsExactly(tuple("someDimension", "dimensionValue"));
     }
 
     @Test
@@ -321,45 +323,6 @@ void shouldThrowExceptionOnPutDashboardIfError() {
                 .isThrownBy(callable);
     }
 
-    @Test
-    void shouldLogMessageOnPutDashboard() {
-
-        // given
-        final var cloudwatchRestDAO = spy(new CloudwatchRestDAO(mock(CloudWatchAsyncClient.class),
-                                                                mock(ObjectMapper.class)));
-        willDoNothing().given(cloudwatchRestDAO).logInfoMessage(any());
-
-        // when
-        cloudwatchRestDAO.handlePutDashboard(Collections.emptyList(), null);
-
-        // then
-        final var captor = ArgumentCaptor.forClass(String.class);
-        then(cloudwatchRestDAO).should().logInfoMessage(captor.capture());
-        assertThat(captor.getValue()).as("Log message was not created.").isEqualTo("Dashboard annotated");
-
-    }
-
-    @Test
-    void shouldAlsoLogValidationWarningsOnPutDashboard() {
-
-        // given
-        final var cloudwatchRestDAO = spy(new CloudwatchRestDAO(mock(CloudWatchAsyncClient.class),
-                                                                mock(ObjectMapper.class)));
-        willDoNothing().given(cloudwatchRestDAO).logInfoMessage(any());
-
-        // when
-        cloudwatchRestDAO.handlePutDashboard(List.of(DashboardValidationMessage.builder()
-                                                                               .message("some validation")
-                                                                               .build()), null);
-
-        // then
-        final var captor = ArgumentCaptor.forClass(String.class);
-        then(cloudwatchRestDAO).should(times(2)).logInfoMessage(captor.capture());
-        assertThat(captor.getAllValues()).as("Incorrect validation warnings.")
-                                         .contains("Dashboard annotated", "BUT: some validation");
-
-    }
-
     @Test
     void shouldAddNewAnnotation() {
 
@@ -375,9 +338,10 @@ void shouldAddNewAnnotation() {
 
         // then
         final var verticalAnnotations = widget.getProperties().getAnnotations().getVertical();
-        assertThat(verticalAnnotations).as("Size of vertical annotations is incorrect.").hasSize(1);
-        assertThat(verticalAnnotations.get(0).getLabel()).as("Vertival annotations label is incorrect.")
-                                                         .isEqualTo("somePrefix Start");
+        assertThat(verticalAnnotations)
+                .as("Vertival annotations label is incorrect.")
+                .extracting(AnnotationDTO::getLabel)
+                .containsExactly("somePrefix Start");
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ If you have any questions please open an issue ticket!`
`9`	`9`	`Add this to your build.gradle.kts`
`10`	`10`	```kotlin
`11`	`11`	`dependencies {`
`12`		`- implementation("de.inoxio:spring-cloudwatch-metrics:2.0.0")`
	`12`	`+ implementation("de.inoxio:spring-cloudwatch-metrics:2.0.1")`
`13`	`13`	`}`
`14`	`14`	```
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ plugins {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`group = "de.inoxio"`
`15`		`-version = "2.0.0"`
	`15`	`+version = "2.0.1"`
`16`	`16`	`description = "A java-spring library to push metrics to cloudwatch"`
`17`	`17`
`18`	`18`	`repositories {`