Default to not creating a StorageResolution Json property using JsonIgnore and having a default enum value

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Metrics/IMetrics.cs

@@ -65,7 +65,7 @@ public interface IMetrics : IDisposable
     /// <param name="defaultDimensions">Metric default dimensions</param>
     /// <param name="metricResolution">Metrics resolution</param>
     void PushSingleMetric(string metricName, double value, MetricUnit unit, string nameSpace = null,
-        string service = null, Dictionary<string, string> defaultDimensions = null, MetricResolution metricResolution = MetricResolution.Standard);
+        string service = null, Dictionary<string, string> defaultDimensions = null, MetricResolution metricResolution = MetricResolution.Default);
 
     /// <summary>
     ///     Sets the namespace

libraries/src/AWS.Lambda.Powertools.Metrics/Internal/MetricsAspectHandler.cs

@@ -106,8 +106,7 @@ public void OnEntry(AspectEventArgs eventArgs)
             MetricUnit.Count,
             nameSpace,
             service,
-            dimensions,
-            MetricResolution.Standard
+            dimensions
         );
     }
 

libraries/src/AWS.Lambda.Powertools.Metrics/Metrics.cs

@@ -264,7 +264,7 @@ public void Dispose()
     /// <param name="unit">Metric Unit</param>
     /// <param name="metricResolution"></param>
     public static void AddMetric(string key, double value, MetricUnit unit = MetricUnit.None,
-        MetricResolution metricResolution = MetricResolution.Standard)
+        MetricResolution metricResolution = MetricResolution.Default)
     {
         _instance.AddMetric(key, value, unit, metricResolution);
     }
@@ -340,7 +340,7 @@ private void Flush(MetricsContext context)
     /// <param name="defaultDimensions">Default dimensions list</param>
     /// <param name="metricResolution">Metrics resolution</param>
     public static void PushSingleMetric(string metricName, double value, MetricUnit unit, string nameSpace = null,
-        string service = null, Dictionary<string, string> defaultDimensions = null, MetricResolution metricResolution = MetricResolution.Standard)
+        string service = null, Dictionary<string, string> defaultDimensions = null, MetricResolution metricResolution = MetricResolution.Default)
     {
         _instance.PushSingleMetric(metricName, value, unit, nameSpace, service, defaultDimensions, metricResolution);
     }

libraries/src/AWS.Lambda.Powertools.Metrics/Model/MetricDefinition.cs

@@ -28,7 +28,7 @@ public class MetricDefinition
     /// </summary>
     /// <param name="name">Metric name</param>
     /// <param name="value">Metric value</param>
-    public MetricDefinition(string name, double value) : this(name, MetricUnit.None, new List<double> {value}, MetricResolution.Standard)
+    public MetricDefinition(string name, double value) : this(name, MetricUnit.None, new List<double> {value}, MetricResolution.Default)
     {
     }
 
@@ -84,6 +84,7 @@ public MetricDefinition(string name, MetricUnit unit, List<double> values, Metri
     /// </summary>
     /// <value>The unit.</value>
     [JsonPropertyName(nameof(StorageResolution))]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public MetricResolution StorageResolution { get; set; }
 
     /// <summary>

libraries/src/AWS.Lambda.Powertools.Metrics/Model/MetricResolution.cs

@@ -18,4 +18,9 @@ public enum MetricResolution
     ///     High resolution, with data at a granularity of one second
     /// </summary>
     High = 1,
+    
+    /// <summary>
+    /// When not set default to not sending metric resolution
+    /// </summary>
+    Default = 0
 }

libraries/tests/AWS.Lambda.Powertools.Metrics.Tests/EMFValidationTests.cs

@@ -103,7 +103,7 @@ public void WhenCaptureColdStartEnabled_ValidateExists()
             var result = consoleOut.ToString();
 
             // Assert
-            Assert.Contains("\"Metrics\":[{\"Name\":\"ColdStart\",\"Unit\":\"Count\",\"StorageResolution\":60}]", result);
+            Assert.Contains("\"Metrics\":[{\"Name\":\"ColdStart\",\"Unit\":\"Count\"}]", result);
             Assert.Contains("\"ColdStart\":1", result);
 
             handler.ResetForTest();
@@ -146,7 +146,7 @@ public void When100MetricsAreAdded_FlushAutomatically()
             var metricsOutput = consoleOut.ToString();
 
             // Assert
-            Assert.Contains("{\"Namespace\":\"dotnet-powertools-test\",\"Metrics\":[{\"Name\":\"Metric Name 101\",\"Unit\":\"Count\",\"StorageResolution\":60}],\"Dimensions\":[[\"Service\"]", metricsOutput);
+            Assert.Contains("{\"Namespace\":\"dotnet-powertools-test\",\"Metrics\":[{\"Name\":\"Metric Name 101\",\"Unit\":\"Count\"}],\"Dimensions\":[[\"Service\"]", metricsOutput);
 
             // Reset
             handler.ResetForTest();
@@ -490,7 +490,7 @@ public void WhenMetricsAndMetadataAdded_ValidateOutput()
             var result = consoleOut.ToString();
 
             // Assert
-            Assert.Contains("CloudWatchMetrics\":[{\"Namespace\":\"dotnet-powertools-test\",\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"Milliseconds\",\"StorageResolution\":60}],\"Dimensions\":[[\"Service\"],[\"functionVersion\"]]}]},\"Service\":\"testService\",\"functionVersion\":\"$LATEST\",\"env\":\"dev\",\"Time\":100.7}"
+            Assert.Contains("CloudWatchMetrics\":[{\"Namespace\":\"dotnet-powertools-test\",\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"Milliseconds\"}],\"Dimensions\":[[\"Service\"],[\"functionVersion\"]]}]},\"Service\":\"testService\",\"functionVersion\":\"$LATEST\",\"env\":\"dev\",\"Time\":100.7}"
                 , result);
 
             // Reset
@@ -531,7 +531,7 @@ public void WhenMetricsWithSameNameAdded_ValidateMetricArray()
             var result = consoleOut.ToString();
 
             // Assert
-            Assert.Contains("\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"Milliseconds\",\"StorageResolution\":60}]"
+            Assert.Contains("\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"Milliseconds\"}]"
                 , result);
             Assert.Contains("\"Time\":[100.5,200]"
                 , result);