Update setDefaultDimensions to take a DimensionSet instead of a Map.

Author: phipag

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsLogger.java

@@ -67,7 +67,7 @@ default void addMetric(String key, double value) {
     default void addDimension(String key, String value) {
         addDimension(DimensionSet.of(key, value));
     }
-    
+
     /**
      * Add a dimension set to the metrics logger
      *
@@ -86,9 +86,9 @@ default void addDimension(String key, String value) {
     /**
      * Set default dimensions for the metrics logger
      *
-     * @param defaultDimensions map of default dimensions
+     * @param dimensionSet the dimension set to use as default dimensions
      */
-    void setDefaultDimensions(Map<String, String> defaultDimensions);
+    void setDefaultDimensions(DimensionSet dimensionSet);
 
     /**
      * Get the default dimensions for the metrics logger

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsLoggerBuilder.java

@@ -16,6 +16,7 @@
 
 import java.util.LinkedHashMap;
 import java.util.Map;
+import software.amazon.lambda.powertools.metrics.model.DimensionSet;
 
 import software.amazon.lambda.powertools.metrics.provider.MetricsProvider;
 
@@ -101,11 +102,13 @@ public MetricsLoggerBuilder withDefaultDimension(String key, String value) {
     /**
      * Add default dimensions
      *
-     * @param dimensions map of dimensions
+     * @param dimensionSet the dimension set to add
      * @return this builder
      */
-    public MetricsLoggerBuilder withDefaultDimensions(Map<String, String> dimensions) {
-        this.defaultDimensions.putAll(dimensions);
+    public MetricsLoggerBuilder withDefaultDimensions(DimensionSet dimensionSet) {
+        if (dimensionSet != null) {
+            this.defaultDimensions.putAll(dimensionSet.getDimensions());
+        }
         return this;
     }
 
@@ -128,12 +131,12 @@ public MetricsLogger build() {
         metricsLogger.setRaiseOnEmptyMetrics(raiseOnEmptyMetrics);
 
         if (service != null) {
-            metricsLogger.setDefaultDimensions(Map.of("Service", service));
+            metricsLogger.setDefaultDimensions(DimensionSet.of("Service", service));
         }
 
         // If the user provided default dimension, we overwrite the default Service dimension again
         if (!defaultDimensions.isEmpty()) {
-            metricsLogger.setDefaultDimensions(defaultDimensions);
+            metricsLogger.setDefaultDimensions(DimensionSet.of(defaultDimensions));
         }
 
         return metricsLogger;

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsLoggerFactory.java

@@ -14,7 +14,7 @@
 
 package software.amazon.lambda.powertools.metrics;
 
-import java.util.Map;
+import software.amazon.lambda.powertools.metrics.model.DimensionSet;
 
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.metrics.provider.EmfMetricsProvider;
@@ -45,7 +45,7 @@ public static synchronized MetricsLogger getMetricsLogger() {
                 metricsLogger.setNamespace(envNamespace);
             }
 
-            metricsLogger.setDefaultDimensions(Map.of("Service", LambdaHandlerProcessor.serviceName()));
+            metricsLogger.setDefaultDimensions(DimensionSet.of("Service", LambdaHandlerProcessor.serviceName()));
         }
 
         return metricsLogger;

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLogger.java

@@ -89,18 +89,23 @@ public void addMetadata(String key, Object value) {
     }
 
     @Override
-    public void setDefaultDimensions(Map<String, String> defaultDimensions) {
-        DimensionSet dimensionSet = new DimensionSet();
-        defaultDimensions.forEach((key, value) -> {
+    public void setDefaultDimensions(software.amazon.lambda.powertools.metrics.model.DimensionSet dimensionSet) {
+        if (dimensionSet == null) {
+            throw new IllegalArgumentException("DimensionSet cannot be null");
+        }
+
+        DimensionSet emfDimensionSet = new DimensionSet();
+        Map<String, String> dimensions = dimensionSet.getDimensions();
+        dimensions.forEach((key, value) -> {
             try {
-                dimensionSet.addDimension(key, value);
+                emfDimensionSet.addDimension(key, value);
             } catch (Exception e) {
                 // Ignore dimension errors
             }
         });
-        emfLogger.setDimensions(dimensionSet);
+        emfLogger.setDimensions(emfDimensionSet);
         // Store a copy of the default dimensions
-        this.defaultDimensions = new LinkedHashMap<>(defaultDimensions);
+        this.defaultDimensions = new LinkedHashMap<>(dimensions);
     }
 
     @Override

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/internal/LambdaMetricsAspect.java

@@ -18,8 +18,6 @@
 import static software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor.extractContext;
 import static software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor.isHandlerMethod;
 
-import java.util.Map;
-
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
@@ -78,7 +76,7 @@ public Object around(ProceedingJoinPoint pjp,
             if (!"".equals(metrics.service())
                     && logger.getDefaultDimensions().getDimensionKeys().size() <= 1
                     && logger.getDefaultDimensions().getDimensionKeys().contains(SERVICE_DIMENSION)) {
-                logger.setDefaultDimensions(Map.of(SERVICE_DIMENSION, metrics.service()));
+                logger.setDefaultDimensions(DimensionSet.of(SERVICE_DIMENSION, metrics.service()));
             }
 
             logger.setRaiseOnEmptyMetrics(metrics.raiseOnEmptyMetrics());

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerBuilderTest.java

@@ -19,7 +19,6 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
-import java.util.Map;
 
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
@@ -28,6 +27,7 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import software.amazon.lambda.powertools.metrics.model.DimensionSet;
 import software.amazon.lambda.powertools.metrics.model.MetricUnit;
 import software.amazon.lambda.powertools.metrics.provider.MetricsProvider;
 import software.amazon.lambda.powertools.metrics.testutils.TestMetricsLogger;
@@ -130,7 +130,7 @@ void shouldBuildWithDefaultDimension() throws Exception {
     void shouldBuildWithMultipleDefaultDimensions() throws Exception {
         // When
         MetricsLogger metricsLogger = MetricsLoggerBuilder.builder()
-                .withDefaultDimensions(Map.of("Environment", "Test", "Region", "us-west-2"))
+                .withDefaultDimensions(DimensionSet.of("Environment", "Test", "Region", "us-west-2"))
                 .build();
 
         metricsLogger.addMetric("test-metric", 100, MetricUnit.COUNT);
@@ -165,7 +165,7 @@ void shouldOverrideServiceWithDefaultDimensions() throws Exception {
         // When
         MetricsLogger metricsLogger = MetricsLoggerBuilder.builder()
                 .withService("OriginalService")
-                .withDefaultDimensions(Map.of("Service", "OverriddenService"))
+                .withDefaultDimensions(DimensionSet.of("Service", "OverriddenService"))
                 .build();
 
         metricsLogger.addMetric("test-metric", 100, MetricUnit.COUNT);

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLoggerTest.java

@@ -20,7 +20,6 @@
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.lang.reflect.Method;
-import java.util.Map;
 import java.util.stream.Stream;
 
 import org.junit.jupiter.api.AfterEach;
@@ -182,12 +181,12 @@ void shouldAddDimension() throws Exception {
         }
         assertThat(hasDimension).isTrue();
     }
-    
+
     @Test
     void shouldAddDimensionSet() throws Exception {
         // Given
         DimensionSet dimensionSet = DimensionSet.of("Dim1", "Value1", "Dim2", "Value2");
-        
+
         // When
         metricsLogger.clearDefaultDimensions(); // Clear default Service dimension first for easier assertions
         metricsLogger.addDimension(dimensionSet);
@@ -218,7 +217,7 @@ void shouldAddDimensionSet() throws Exception {
         assertThat(hasDim1).isTrue();
         assertThat(hasDim2).isTrue();
     }
-    
+
     @Test
     void shouldThrowExceptionWhenDimensionSetIsNull() {
         // When/Then
@@ -245,8 +244,11 @@ void shouldAddMetadata() throws Exception {
 
     @Test
     void shouldSetDefaultDimensions() throws Exception {
+        // Given
+        DimensionSet dimensionSet = DimensionSet.of("Service", "TestService", "Environment", "Test");
+
         // When
-        metricsLogger.setDefaultDimensions(Map.of("Service", "TestService", "Environment", "Test"));
+        metricsLogger.setDefaultDimensions(dimensionSet);
         metricsLogger.addMetric("test-metric", 100);
         metricsLogger.flush();
 
@@ -262,15 +264,26 @@ void shouldSetDefaultDimensions() throws Exception {
 
     @Test
     void shouldGetDefaultDimensions() {
+        // Given
+        DimensionSet dimensionSet = DimensionSet.of("Service", "TestService", "Environment", "Test");
+
         // When
-        metricsLogger.setDefaultDimensions(Map.of("Service", "TestService", "Environment", "Test"));
+        metricsLogger.setDefaultDimensions(dimensionSet);
         DimensionSet dimensions = metricsLogger.getDefaultDimensions();
 
         // Then
         assertThat(dimensions.getDimensions()).containsEntry("Service", "TestService");
         assertThat(dimensions.getDimensions()).containsEntry("Environment", "Test");
     }
 
+    @Test
+    void shouldThrowExceptionWhenDefaultDimensionSetIsNull() {
+        // When/Then
+        assertThatThrownBy(() -> metricsLogger.setDefaultDimensions((DimensionSet) null))
+                .isInstanceOf(IllegalArgumentException.class)
+                .hasMessage("DimensionSet cannot be null");
+    }
+
     @Test
     void shouldSetNamespace() throws Exception {
         // When
@@ -300,7 +313,7 @@ void shouldRaiseExceptionOnEmptyMetrics() {
     @Test
     void shouldClearDefaultDimensions() throws Exception {
         // Given
-        metricsLogger.setDefaultDimensions(Map.of("Service", "TestService", "Environment", "Test"));
+        metricsLogger.setDefaultDimensions(DimensionSet.of("Service", "TestService", "Environment", "Test"));
 
         // When
         metricsLogger.clearDefaultDimensions();

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/testutils/TestMetricsLogger.java

@@ -37,7 +37,7 @@ public void addMetadata(String key, Object value) {
     }
 
     @Override
-    public void setDefaultDimensions(Map<String, String> defaultDimensions) {
+    public void setDefaultDimensions(DimensionSet dimensionSet) {
         // Test placeholder
     }