upgraded embedded metrics library and associated tests

jdoherty · jdoherty · commit 63588ff33623 · 2024-01-05T19:45:01.000Z
diff --git a/examples/powertools-examples-core-utilities/sam/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/sam/src/main/java/helloworld/App.java
@@ -32,6 +32,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
+import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 import software.amazon.lambda.powertools.logging.Logging;
 import software.amazon.lambda.powertools.logging.LoggingUtils;
@@ -63,6 +64,8 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             metric.setDimensions(DimensionSet.of("AnotherService1", "CustomService1"));
         });
 
+        metricsLogger().putMetric("CustomMetric3", 1, Unit.COUNT, StorageResolution.HIGH);
+
         LoggingUtils.appendKey("test", "willBeLogged");
 
         APIGatewayProxyResponseEvent response = new APIGatewayProxyResponseEvent()
diff --git a/pom.xml b/pom.xml
@@ -107,7 +107,7 @@
         <maven-source-plugin.version>3.3.0</maven-source-plugin.version>
         <maven-gpg-plugin.version>3.1.0</maven-gpg-plugin.version>
         <junit.version>5.10.0</junit.version>
-        <aws-embedded-metrics.version>1.0.6</aws-embedded-metrics.version>
+        <aws-embedded-metrics.version>4.1.2</aws-embedded-metrics.version>
         <jmespath.version>0.6.0</jmespath.version>
         <elastic.version>1.5.0</elastic.version>
 
diff --git a/powertools-e2e-tests/handlers/metrics/src/main/java/software/amazon/lambda/powertools/e2e/Function.java b/powertools-e2e-tests/handlers/metrics/src/main/java/software/amazon/lambda/powertools/e2e/Function.java
@@ -18,9 +18,15 @@
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
+import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 import software.amazon.lambda.powertools.metrics.Metrics;
 import software.amazon.lambda.powertools.metrics.MetricsUtils;
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.time.temporal.ChronoUnit;
+import java.time.Instant;
+
 
 public class Function implements RequestHandler<Input, String> {
 
@@ -29,11 +35,14 @@ public class Function implements RequestHandler<Input, String> {
     @Metrics(captureColdStart = true)
     public String handleRequest(Input input, Context context) {
 
+        Instant currentTimeTruncatedPlusThirty = LocalDateTime.now().truncatedTo(ChronoUnit.MINUTES).toInstant(ZoneOffset.UTC).plusSeconds(30);
+        metricsLogger.setTimestamp(currentTimeTruncatedPlusThirty);
+
         DimensionSet dimensionSet = new DimensionSet();
         input.getDimensions().forEach((key, value) -> dimensionSet.addDimension(key, value));
         metricsLogger.putDimensions(dimensionSet);
 
-        input.getMetrics().forEach((key, value) -> metricsLogger.putMetric(key, value, Unit.COUNT));
+        input.getMetrics().forEach((key, value) -> metricsLogger.putMetric(key, value, Unit.COUNT,input.getHighResolution().equalsIgnoreCase("true") ? StorageResolution.HIGH : StorageResolution.STANDARD ));
 
         return "OK";
     }
diff --git a/powertools-e2e-tests/handlers/metrics/src/main/java/software/amazon/lambda/powertools/e2e/Input.java b/powertools-e2e-tests/handlers/metrics/src/main/java/software/amazon/lambda/powertools/e2e/Input.java
@@ -21,6 +21,8 @@ public class Input {
 
     private Map<String, String> dimensions;
 
+    private String highResolution;
+
     public Input() {
     }
 
@@ -32,6 +34,14 @@ public void setMetrics(Map<String, Double> metrics) {
         this.metrics = metrics;
     }
 
+    public String getHighResolution() {
+        return highResolution;
+    }
+
+    public void setHighResolution(String highResolution) {
+        this.highResolution = highResolution;
+    }
+
     public Map<String, String> getDimensions() {
         return dimensions;
     }
diff --git a/powertools-e2e-tests/src/test/java/software/amazon/lambda/powertools/MetricsE2ET.java b/powertools-e2e-tests/src/test/java/software/amazon/lambda/powertools/MetricsE2ET.java
@@ -18,6 +18,10 @@
 import static software.amazon.lambda.powertools.testutils.Infrastructure.FUNCTION_NAME_OUTPUT;
 import static software.amazon.lambda.powertools.testutils.lambda.LambdaInvoker.invokeFunction;
 
+import java.time.Instant;
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.time.temporal.ChronoUnit;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -66,12 +70,19 @@ public static void tearDown() {
     @Test
     public void test_recordMetrics() {
         // GIVEN
+
+        Instant currentTimeTruncatedToMinutes = LocalDateTime.now().truncatedTo(ChronoUnit.MINUTES).toInstant(ZoneOffset.UTC);
+
         String event1 =
-                "{ \"metrics\": {\"orders\": 1, \"products\": 4}, \"dimensions\": { \"Environment\": \"test\"} }";
+                "{ \"metrics\": {\"orders\": 1, \"products\": 4}, \"dimensions\": { \"Environment\": \"test\"}, \"highResolution\": \"false\"}";
 
+        String event2 =
+                "{ \"metrics\": {\"orders\": 1, \"products\": 8}, \"dimensions\": { \"Environment\": \"test\"}, \"highResolution\": \"true\"}";
         // WHEN
         InvocationResult invocationResult = invokeFunction(functionName, event1);
 
+        invokeFunction(functionName, event2);
+
         // THEN
         MetricsFetcher metricsFetcher = new MetricsFetcher();
         List<Double> coldStart =
@@ -84,18 +95,35 @@ public void test_recordMetrics() {
         List<Double> orderMetrics =
                 metricsFetcher.fetchMetrics(invocationResult.getStart(), invocationResult.getEnd(), 60, namespace,
                         "orders", Collections.singletonMap("Environment", "test"));
-        assertThat(orderMetrics.get(0)).isEqualTo(1);
+        assertThat(orderMetrics.get(0)).isEqualTo(2);
         List<Double> productMetrics =
                 metricsFetcher.fetchMetrics(invocationResult.getStart(), invocationResult.getEnd(), 60, namespace,
                         "products", Collections.singletonMap("Environment", "test"));
-        assertThat(productMetrics.get(0)).isEqualTo(4);
+
+        //        When searching across a 1 minute time period with a period of 60 we find both metrics and the sum is 12
+
+        assertThat(productMetrics.get(0)).isEqualTo(12);
+
         orderMetrics =
                 metricsFetcher.fetchMetrics(invocationResult.getStart(), invocationResult.getEnd(), 60, namespace,
                         "orders", Collections.singletonMap("Service", service));
-        assertThat(orderMetrics.get(0)).isEqualTo(1);
+        assertThat(orderMetrics.get(0)).isEqualTo(2);
         productMetrics =
                 metricsFetcher.fetchMetrics(invocationResult.getStart(), invocationResult.getEnd(), 60, namespace,
                         "products", Collections.singletonMap("Service", service));
-        assertThat(productMetrics.get(0)).isEqualTo(4);
+        assertThat(productMetrics.get(0)).isEqualTo(12);
+
+        Instant searchStartTime = currentTimeTruncatedToMinutes.plusSeconds(15);
+        Instant searchEndTime = currentTimeTruncatedToMinutes.plusSeconds(45);
+
+        List<Double> productMetricDataResult =
+                metricsFetcher.fetchMetrics(searchStartTime, searchEndTime, 1, namespace,
+                        "products", Collections.singletonMap("Environment", "test"));
+
+//  We are searching across the time period the metric was created but with a period of 1 second.  Only the high resolution metric will be available at this point
+
+        assertThat(productMetricDataResult.get(0)).isEqualTo(8);
+
+
     }
 }
diff --git a/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerTest.java b/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerTest.java
@@ -25,6 +25,8 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.function.Consumer;
 import org.junit.jupiter.api.AfterEach;
@@ -35,6 +37,7 @@
 import software.amazon.cloudwatchlogs.emf.config.SystemWrapper;
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
+import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 
 class MetricsLoggerTest {
@@ -245,6 +248,7 @@ private void testLogger(Consumer<Consumer<MetricsLogger>> methodToTest) {
             {
                 metricsLogger.setDimensions(DimensionSet.of("Dimension1", "Value1"));
                 metricsLogger.putMetric("Metric1", 1, Unit.COUNT);
+                metricsLogger.putMetric("Metric2", 1, Unit.COUNT, StorageResolution.HIGH);
             });
 
             assertThat(out.toString())
@@ -263,6 +267,12 @@ private void testLogger(Consumer<Consumer<MetricsLogger>> methodToTest) {
                         assertThat(aws.get("CloudWatchMetrics"))
                                 .asString()
                                 .contains("Namespace=GlobalName");
+
+                        ArrayList cloudWatchMetrics = (ArrayList) aws.get("CloudWatchMetrics");
+                        LinkedHashMap<String,Object> values = (java.util.LinkedHashMap<String, Object>) cloudWatchMetrics.get(0);
+                        ArrayList metricArray = (ArrayList) values.get("Metrics");
+                        LinkedHashMap<String,Object> metricValues = (LinkedHashMap<String, Object>) metricArray.get(1);
+                        assertThat(metricValues.get("StorageResolution")).isEqualTo(1);
                     });
         }
     }
diff --git a/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/handlers/PowertoolsMetricsTooManyDimensionsHandler.java b/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/handlers/PowertoolsMetricsTooManyDimensionsHandler.java
@@ -26,13 +26,14 @@
 public class PowertoolsMetricsTooManyDimensionsHandler implements RequestHandler<Object, Object> {
 
     @Override
-    @Metrics
+    @Metrics(namespace = "ExampleApplication",service = "booking")
     public Object handleRequest(Object input, Context context) {
         MetricsLogger metricsLogger = metricsLogger();
-
-        metricsLogger.setDimensions(IntStream.range(1, 15)
-                .mapToObj(value -> DimensionSet.of("Dimension" + value, "DimensionValue" + value))
-                .toArray(DimensionSet[]::new));
+        DimensionSet dimensionSet = new DimensionSet();
+        for (int i = 0; i < 35; i++) {
+            dimensionSet.addDimension("Dimension" + i, "value" + i);
+        }
+        metricsLogger.setDimensions(dimensionSet);
 
         return null;
     }
diff --git a/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/LambdaMetricsAspectTest.java b/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/LambdaMetricsAspectTest.java
@@ -40,6 +40,7 @@
 import org.mockito.Mock;
 import org.mockito.MockedStatic;
 import software.amazon.cloudwatchlogs.emf.config.SystemWrapper;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.metrics.MetricsUtils;
 import software.amazon.lambda.powertools.metrics.ValidationException;
@@ -389,9 +390,9 @@ public void exceptionWhenTooManyDimensionsSet() {
 
             requestHandler = new PowertoolsMetricsTooManyDimensionsHandler();
 
-            assertThatExceptionOfType(ValidationException.class)
+            assertThatExceptionOfType(DimensionSetExceededException.class)
                     .isThrownBy(() -> requestHandler.handleRequest("input", context))
-                    .withMessage("Number of Dimensions must be in range of 0-9. Actual size: 14.");
+                    .withMessage("Maximum number of dimensions allowed are 30. Account for default dimensions if not using setDimensions.");
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ public class Input {`
`21`	`21`
`22`	`22`	`private Map<String, String> dimensions;`
`23`	`23`
	`24`	`+ private String highResolution;`
	`25`	`+`
`24`	`26`	`public Input() {`
`25`	`27`	`}`
`26`	`28`
`@@ -32,6 +34,14 @@ public void setMetrics(Map<String, Double> metrics) {`
`32`	`34`	`this.metrics = metrics;`
`33`	`35`	`}`
`34`	`36`
	`37`	`+ public String getHighResolution() {`
	`38`	`+ return highResolution;`
	`39`	`+ }`
	`40`	`+`
	`41`	`+ public void setHighResolution(String highResolution) {`
	`42`	`+ this.highResolution = highResolution;`
	`43`	`+ }`
	`44`	`+`
`35`	`45`	`public Map<String, String> getDimensions() {`
`36`	`46`	`return dimensions;`
`37`	`47`	`}`