Change DimensionSetExceededException to a checked exception (#122)

* change DimensionSetExceededException to a checked exception * fix tests * fix integ tests
awslabs · Sep 16, 2022 · 005f734 · 005f734
1 parent 125a637
commit 005f734
Show file tree

Hide file tree

Showing 15 changed files with 120 additions and 61 deletions.
diff --git a/canarytests/agent/src/main/java/emf/canary/ECSRunnable.java b/canarytests/agent/src/main/java/emf/canary/ECSRunnable.java
@@ -2,6 +2,7 @@
 
 import software.amazon.cloudwatchlogs.emf.config.Configuration;
 import software.amazon.cloudwatchlogs.emf.config.EnvironmentConfigurationProvider;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidNamespaceException;
@@ -33,7 +34,7 @@ public void run() {
                             "Platform", "ECS",
                             "Agent", "CloudWatchAgent",
                             "Version", version));
-        } catch (InvalidNamespaceException | InvalidDimensionException e) {
+        } catch (InvalidNamespaceException | InvalidDimensionException | DimensionSetExceededException e) {
             System.out.println(e);
         }
 

diff --git a/examples/agent/src/main/java/agent/App.java b/examples/agent/src/main/java/agent/App.java
@@ -3,6 +3,7 @@
 import software.amazon.cloudwatchlogs.emf.config.EnvironmentConfigurationProvider;
 import software.amazon.cloudwatchlogs.emf.environment.DefaultEnvironment;
 import software.amazon.cloudwatchlogs.emf.environment.Environment;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
@@ -19,13 +20,14 @@ public static void main(String[] args) {
             emitMetric(environment);
             emitMetric(environment);
             emitMetric(environment);
-        } catch (InvalidMetricException | InvalidDimensionException e) {
+        } catch (InvalidMetricException | InvalidDimensionException | DimensionSetExceededException e) {
             System.out.println(e);
         }
         environment.getSink().shutdown().orTimeout(360_000L, TimeUnit.MILLISECONDS);
     }
 
-    private static void emitMetric(Environment environment) throws InvalidDimensionException, InvalidMetricException {
+    private static void emitMetric(Environment environment)
+            throws InvalidDimensionException, InvalidMetricException, DimensionSetExceededException {
         MetricsLogger logger = new MetricsLogger(environment);
         logger.setDimensions(DimensionSet.of("Operation", "Agent"));
         logger.putMetric("ExampleMetric", 100, Unit.MILLISECONDS);

diff --git a/examples/lambda/src/main/java/Handler.java b/examples/lambda/src/main/java/Handler.java
@@ -1,5 +1,6 @@
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
@@ -19,7 +20,7 @@ public String handleRequest(Map<String, String> event, Context context) {
         try {
             logger.putDimensions(DimensionSet.of("Service", "Aggregator"));
             logger.putMetric("ProcessingLatency", 100, Unit.MILLISECONDS);
-        } catch (InvalidDimensionException | InvalidMetricException e) {
+        } catch (InvalidDimensionException | InvalidMetricException | DimensionSetExceededException e) {
             System.out.println(e);
         }
 

diff --git a/...ntegration-test/java/software/amazon/cloudwatchlogs/emf/MetricsLoggerIntegrationTest.java b/...ntegration-test/java/software/amazon/cloudwatchlogs/emf/MetricsLoggerIntegrationTest.java
@@ -33,6 +33,7 @@
 import software.amazon.cloudwatchlogs.emf.config.EnvironmentConfigurationProvider;
 import software.amazon.cloudwatchlogs.emf.environment.DefaultEnvironment;
 import software.amazon.cloudwatchlogs.emf.environment.Environment;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
 import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
@@ -50,7 +51,8 @@ public class MetricsLoggerIntegrationTest {
     private DimensionSet dimensions = DimensionSet.of(dimensionName, dimensionValue);
     private EMFIntegrationTestHelper testHelper = new EMFIntegrationTestHelper();
 
-    public MetricsLoggerIntegrationTest() throws InvalidDimensionException {}
+    public MetricsLoggerIntegrationTest()
+            throws InvalidDimensionException, DimensionSetExceededException {}
 
     @Before
     public void setUp() {

diff --git a/...main/java/software/amazon/cloudwatchlogs/emf/exception/DimensionSetExceededException.java b/...main/java/software/amazon/cloudwatchlogs/emf/exception/DimensionSetExceededException.java
@@ -18,7 +18,7 @@
 
 import software.amazon.cloudwatchlogs.emf.Constants;
 
-public class DimensionSetExceededException extends RuntimeException {
+public class DimensionSetExceededException extends Exception {
 
     public DimensionSetExceededException() {
         super(

diff --git a/src/main/java/software/amazon/cloudwatchlogs/emf/model/DimensionSet.java b/src/main/java/software/amazon/cloudwatchlogs/emf/model/DimensionSet.java
@@ -40,8 +40,10 @@ public class DimensionSet {
      * @param v1 Value of the single dimension
      * @return a DimensionSet from the parameters
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
-    public static DimensionSet of(String d1, String v1) throws InvalidDimensionException {
+    public static DimensionSet of(String d1, String v1)
+            throws InvalidDimensionException, DimensionSetExceededException {
         return fromEntries(entryOf(d1, v1));
     }
 
@@ -54,9 +56,10 @@ public static DimensionSet of(String d1, String v1) throws InvalidDimensionExcep
      * @param v2 Value of the second dimension
      * @return a DimensionSet from the parameters
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
     public static DimensionSet of(String d1, String v1, String d2, String v2)
-            throws InvalidDimensionException {
+            throws InvalidDimensionException, DimensionSetExceededException {
         return fromEntries(entryOf(d1, v1), entryOf(d2, v2));
     }
 
@@ -71,9 +74,10 @@ public static DimensionSet of(String d1, String v1, String d2, String v2)
      * @param v3 Value of the third dimension
      * @return a DimensionSet from the parameters
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
     public static DimensionSet of(String d1, String v1, String d2, String v2, String d3, String v3)
-            throws InvalidDimensionException {
+            throws InvalidDimensionException, DimensionSetExceededException {
         return fromEntries(entryOf(d1, v1), entryOf(d2, v2), entryOf(d3, v3));
     }
 
@@ -90,10 +94,11 @@ public static DimensionSet of(String d1, String v1, String d2, String v2, String
      * @param v4 Value of the fourth dimension
      * @return a DimensionSet from the parameters
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
     public static DimensionSet of(
             String d1, String v1, String d2, String v2, String d3, String v3, String d4, String v4)
-            throws InvalidDimensionException {
+            throws InvalidDimensionException, DimensionSetExceededException {
 
         return fromEntries(entryOf(d1, v1), entryOf(d2, v2), entryOf(d3, v3), entryOf(d4, v4));
     }
@@ -113,6 +118,7 @@ public static DimensionSet of(
      * @param v5 Value of the fifth dimension
      * @return a DimensionSet from the parameters
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
     public static DimensionSet of(
             String d1,
@@ -125,7 +131,7 @@ public static DimensionSet of(
             String v4,
             String d5,
             String v5)
-            throws InvalidDimensionException {
+            throws InvalidDimensionException, DimensionSetExceededException {
 
         return fromEntries(
                 entryOf(d1, v1),
@@ -136,7 +142,7 @@ public static DimensionSet of(
     }
 
     private static DimensionSet fromEntries(DimensionEntry... entries)
-            throws InvalidDimensionException {
+            throws InvalidDimensionException, DimensionSetExceededException {
         DimensionSet ds = new DimensionSet();
         for (DimensionEntry entry : entries) {
             ds.addDimension(entry.key, entry.value);
@@ -154,8 +160,10 @@ private static DimensionEntry entryOf(String key, String value) {
      * @param dimension Name of the dimension
      * @param value Value of the dimension
      * @throws InvalidDimensionException if the dimension name or value is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
-    public void addDimension(String dimension, String value) throws InvalidDimensionException {
+    public void addDimension(String dimension, String value)
+            throws InvalidDimensionException, DimensionSetExceededException {
         Validator.validateDimensionSet(dimension, value);
 
         if (this.getDimensionKeys().size() >= Constants.MAX_DIMENSION_SET_SIZE) {
@@ -171,8 +179,9 @@ public void addDimension(String dimension, String value) throws InvalidDimension
      *
      * @param other Other dimension sets to merge with current
      * @return a new DimensionSet from combining the current DimensionSet with other
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
-    public DimensionSet add(DimensionSet other) {
+    public DimensionSet add(DimensionSet other) throws DimensionSetExceededException {
         DimensionSet mergedDimensionSet = new DimensionSet();
         int mergedDimensionSetSize =
                 this.getDimensionKeys().size() + other.dimensionRecords.keySet().size();

diff --git a/src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricDirective.java b/src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricDirective.java
@@ -22,6 +22,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
 import lombok.*;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 
 /** Represents the MetricDirective part of the EMF schema. */
 @AllArgsConstructor
@@ -87,7 +88,7 @@ Collection<MetricDefinition> getAllMetrics() {
     }
 
     @JsonProperty("Dimensions")
-    List<Set<String>> getAllDimensionKeys() {
+    List<Set<String>> getAllDimensionKeys() throws DimensionSetExceededException {
         return getAllDimensions().stream()
                 .map(DimensionSet::getDimensionKeys)
                 .collect(Collectors.toList());
@@ -128,7 +129,7 @@ void resetDimensions(boolean useDefault) {
      * Return all the dimension sets. If there's a default dimension set, the custom dimensions are
      * prepended with the default dimensions.
      */
-    List<DimensionSet> getAllDimensions() {
+    List<DimensionSet> getAllDimensions() throws DimensionSetExceededException {
         if (!shouldUseDefaultDimension) {
             return dimensions;
         }
@@ -137,9 +138,12 @@ List<DimensionSet> getAllDimensions() {
             return Arrays.asList(defaultDimensions);
         }
 
-        return dimensions.stream()
-                .map(dim -> defaultDimensions.add(dim))
-                .collect(Collectors.toList());
+        List<DimensionSet> allDimensions = new ArrayList<>();
+        for (DimensionSet dim : dimensions) {
+            allDimensions.add(defaultDimensions.add(dim));
+        }
+
+        return allDimensions;
     }
 
     /**

diff --git a/src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricsContext.java b/src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricsContext.java
@@ -21,6 +21,7 @@
 import java.util.*;
 import lombok.Getter;
 import software.amazon.cloudwatchlogs.emf.Constants;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidDimensionException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidMetricException;
 import software.amazon.cloudwatchlogs.emf.exception.InvalidNamespaceException;
@@ -179,13 +180,20 @@ public void putDimension(DimensionSet dimensionSet) {
      * @param dimension the name of the dimension
      * @param value the value associated with the dimension
      * @throws InvalidDimensionException if the dimension is invalid
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
      */
-    public void putDimension(String dimension, String value) throws InvalidDimensionException {
+    public void putDimension(String dimension, String value)
+            throws InvalidDimensionException, DimensionSetExceededException {
         metricDirective.putDimensionSet(DimensionSet.of(dimension, value));
     }
 
-    /** @return the list of dimensions that has been added, including default dimensions. */
-    public List<DimensionSet> getDimensions() {
+    /**
+     * Get list of all dimensions including default dimensions
+     *
+     * @return the list of dimensions that has been added, including default dimensions.
+     * @throws DimensionSetExceededException if the number of dimensions exceeds the limit
+     */
+    public List<DimensionSet> getDimensions() throws DimensionSetExceededException {
         return metricDirective.getAllDimensions();
     }
 

diff --git a/src/main/java/software/amazon/cloudwatchlogs/emf/model/RootNode.java b/src/main/java/software/amazon/cloudwatchlogs/emf/model/RootNode.java
@@ -29,6 +29,7 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.With;
+import software.amazon.cloudwatchlogs.emf.exception.DimensionSetExceededException;
 
 /** Represents the root of the EMF schema. */
 @AllArgsConstructor
@@ -60,7 +61,7 @@ Map<String, Object> getProperties() {
 
     /** Return the target members that are referenced by metrics, dimensions and properties. */
     @JsonAnyGetter
-    Map<String, Object> getTargetMembers() {
+    Map<String, Object> getTargetMembers() throws DimensionSetExceededException {
         Map<String, Object> targetMembers = new HashMap<>();
         targetMembers.putAll(properties);
         targetMembers.putAll(getDimensions());
@@ -74,7 +75,7 @@ Map<String, Object> getTargetMembers() {
     }
 
     /** Return a list of all dimensions that are referenced by each dimension set. */
-    Map<String, String> getDimensions() {
+    Map<String, String> getDimensions() throws DimensionSetExceededException {
         Map<String, String> dimensions = new HashMap<>();
         for (MetricDirective mc : aws.getCloudWatchMetrics()) {
             for (DimensionSet dimensionSet : mc.getAllDimensions()) {