Merge pull request #48 from rayabagi/feature/emf-high-resolution

Add support for high-resolution metrics in EMF

Author: rayabagi

README.md

@@ -36,8 +36,10 @@ using (var logger = new MetricsLogger()) {
     var dimensionSet = new DimensionSet();
     dimensionSet.AddDimension("Service", "aggregator");
     logger.SetDimensions(dimensionSet);
-    logger.PutMetric("ProcessingLatency", 100, Unit.MILLISECONDS);
+    logger.PutMetric("ProcessingLatency", 100, Unit.MILLISECONDS,StorageResolution.STANDARD);
+    logger.PutMetric("Memory.HeapUsed", "1600424.0", Unit.BYTES, StorageResolution.HIGH);
     logger.PutProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8");
+    
 }
 ```
 
@@ -66,6 +68,7 @@ using (var logger = new MetricsLogger()) {
     dimensionSet.AddDimension("Service", "aggregator");
     logger.SetDimensions(dimensionSet);
     logger.PutMetric("ProcessingLatency", 100, Unit.MILLISECONDS);
+    logger.PutMetric("Memory.HeapUsed", "1600424.0", Unit.BYTES, StorageResolution.HIGH); 
     logger.PutProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8");
 }
 
@@ -155,19 +158,28 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
 
 ### MetricsLogger
 
-The `MetricsLogger` is the interface you will use to publish embedded metrics.
+The `MetricsLogger` is the interface you will use to publish embedded metrics. 
 
-- MetricsLogger **PutMetric**(string key, double value, Unit unit)
 - MetricsLogger **PutMetric**(string key, double value)
+- MetricsLogger **PutMetric**(string key, double value, Unit unit)
+- MetricsLogger **PutMetric**(string key, double value, StorageResolution storageResolution)
+- MetricsLogger **PutMetric**(string key, double value, Unit unit, StorageResolution storageResolution)
 
-Adds a new metric to the current logger context. Multiple metrics using the same key will be appended to an array of values. The Embedded Metric Format supports a maxumum of 100 metrics per key.
+Adds a new metric to the current logger context. Multiple metrics using the same key will be appended to an array of values. Multiple metrics cannot have the same key but different storage resolutions. Same metric cannot have different storage resolutions otherwise a `InvalidMetricException` will be thrown. The Embedded Metric Format supports a maxumum of 100 metrics per key.
 
 Metrics must meet CloudWatch Metrics requirements, otherwise a `InvalidMetricException` will be thrown. See [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) for valid values.
 
+##### Storage Resolution.
+An OPTIONAL value representing the storage resolution for the corresponding metric. Setting this to `High` specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to `Standard` specifies this metric as a standard-resolution metric, which CloudWatch stores at 1-minute resolution. If a value is not provided, then a default value of `Standard` is assumed. See [Cloud Watch High-Resolution metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics)
+
 Example:
 
 ```c#
+// Standard Resolution Example
 metrics.PutMetric("ProcessingLatency", 101, Unit.MILLISECONDS);
+
+// High Resolution Example
+logger.PutMetric("Memory.HeapUsed", "1600424.0", Unit.BYTES, StorageResolution.HIGH);
 ```
 
 - MetricsLogger **PutProperty**(string key, object value)

examples/Amazon.CloudWatch.EMF.Examples.ConsoleApp/Program.cs

@@ -38,7 +38,6 @@ static void Main(string[] args)
             }
 
             logger.LogInformation("Shutting down");
-            
             environment.Sink.Shutdown().Wait(TimeSpan.FromSeconds(120));
         }
 
@@ -50,9 +49,14 @@ private static void EmitMetrics(ILogger logger, IMetricsLogger metrics)
             dimensionSet.AddDimension("Region", "us-west-2");
             metrics.SetDimensions(dimensionSet);
 
+            // Standard Resolutions
             metrics.PutMetric("ProcessingLatency", 101, Unit.MILLISECONDS);
             metrics.PutMetric("ProcessingLatency", 100, Unit.MILLISECONDS);
             metrics.PutMetric("ProcessingLatency", 99, Unit.MILLISECONDS);
+
+            // High Resolution
+            metrics.PutMetric("Memory.HeapUsed", GC.GetTotalMemory(false), Unit.BYTES, StorageResolution.HIGH);
+
             metrics.PutMetric("Count", 3, Unit.COUNT);
             metrics.PutProperty("AccountId", "123456789");
             metrics.PutProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8");

examples/Amazon.CloudWatch.EMF.Examples.Lambda/Function.cs

@@ -4,6 +4,7 @@
 using Amazon.CloudWatch.EMF.Logger;
 using Amazon.CloudWatch.EMF.Model;
 using Amazon.Lambda.Core;
+using System.Text;
 
 // Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
 [assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))]
@@ -32,6 +33,7 @@ public string FunctionHandler(string input, ILambdaContext context)
             logger.PutMetric("ProcessingLatency", 100, Unit.MILLISECONDS);
             logger.PutMetric("ProcessingLatency", 99, Unit.MILLISECONDS);
             logger.PutMetric("Count", 3, Unit.COUNT);
+            logger.PutMetric("InputPayloadSize", ASCIIEncoding.ASCII.GetByteCount(input), Unit.BYTES, StorageResolution.HIGH);
             logger.PutProperty("AccountId", "123456789");
             logger.PutProperty("RequestId", "422b1569-16f6-4a03-b8f0-fe3fd9b100f8");
             logger.PutProperty("DeviceId", "61270781-c6ac-46f1-baf7-22c808af8162");

examples/Amazon.CloudWatch.EMF.Examples.Web/Controllers/WeatherForecastController.cs

@@ -23,7 +23,7 @@ public class WeatherForecastController : ControllerBase
         private readonly IMetricsLogger _metrics;
 
         public WeatherForecastController(
-            ILogger<WeatherForecastController> logger, 
+            ILogger<WeatherForecastController> logger,
             IMetricsLogger metrics)
         {
             _logger = logger;
@@ -36,8 +36,10 @@ public IEnumerable<WeatherForecast> Get()
             Thread.Sleep(100);
             var rng = new Random();
             var temperature = rng.Next(-20, 55);
+            var WindSpeed = rng.Next(10, 100);
 
             _metrics.PutMetric("Temperature", temperature, Unit.NONE);
+            _metrics.PutMetric("WindSpeed", WindSpeed, Unit.NONE, StorageResolution.HIGH);
 
             return Enumerable.Range(1, 5).Select(index => new WeatherForecast
             {

examples/Amazon.CloudWatch.EMF.Examples.Web/Startup.cs

@@ -9,7 +9,7 @@ namespace Amazon.CloudWatch.EMF.Web
     public class Startup
     {
         public Startup(
-            IConfiguration configuration, 
+            IConfiguration configuration,
             IHostEnvironment hostEnv)
         {
             Configuration = configuration;
@@ -19,10 +19,10 @@ public Startup(
                 ServiceName = "WeatherApp",
                 LogGroupName = "/Canary/Dotnet/CloudWatchAgent/Metrics",
                 EnvironmentOverride = hostEnv.IsDevelopment()
-                    ? EMF.Environment.Environments.Local
-                    // Setting this to unknown will cause the SDK to attempt to 
-                    // detect the environment. If you know the compute environment
-                    // you will be running on, then you can set this yourself.
+                    ? EMF.Environment.Environments.Local
+                    // Setting this to unknown will cause the SDK to attempt to 
+                    // detect the environment. If you know the compute environment
+                    // you will be running on, then you can set this yourself.
                     : EMF.Environment.Environments.Unknown
             };
         }

src/Amazon.CloudWatch.EMF/Config/ConfigurationKeys.cs

@@ -2,13 +2,13 @@ namespace Amazon.CloudWatch.EMF.Config
 {
     public class ConfigurationKeys
     {
-        public const string ENV_VAR_PREFIX = "AWS_EMF";
-        public const string SERVICE_NAME = "SERVICE_NAME";
-        public const string SERVICE_TYPE = "SERVICE_TYPE";
-        public const string LOG_GROUP_NAME = "LOG_GROUP_NAME";
-        public const string LOG_STREAM_NAME = "LOG_STREAM_NAME";
-        public const string AGENT_ENDPOINT = "AGENT_ENDPOINT";
-        public const string AGENT_BUFFER_SIZE = "AGENT_BUFFER_SIZE";
-        public const string ENVIRONMENT_OVERRIDE = "ENVIRONMENT";
+        public const string EnvVarPrefix = "AWS_EMF";
+        public const string ServiceName = "SERVICE_NAME";
+        public const string ServiceType = "SERVICE_TYPE";
+        public const string LogGroupName = "LOG_GROUP_NAME";
+        public const string LogStreamName = "LOG_STREAM_NAME";
+        public const string AgentEndpoint = "AGENT_ENDPOINT";
+        public const string AgentBufferSize = "AGENT_BUFFER_SIZE";
+        public const string EnvironmentOverride = "ENVIRONMENT";
     }
 }

src/Amazon.CloudWatch.EMF/Config/EnvironmentConfigurationProvider.cs

@@ -16,16 +16,16 @@ public static IConfiguration Config
             get
             {
                 var bufferSize = Int32.TryParse(
-                        GetEnvVar(ConfigurationKeys.AGENT_BUFFER_SIZE), out var parsedBufferSize)
+                        GetEnvVar(ConfigurationKeys.AgentBufferSize), out var parsedBufferSize)
                             ? parsedBufferSize
                             : Configuration.DEFAULT_AGENT_BUFFER_SIZE;
 
                 return _config ??= new Configuration(
-                    GetEnvVar(ConfigurationKeys.SERVICE_NAME),
-                    GetEnvVar(ConfigurationKeys.SERVICE_TYPE),
-                    GetEnvVar(ConfigurationKeys.LOG_GROUP_NAME),
-                    GetEnvVar(ConfigurationKeys.LOG_STREAM_NAME),
-                    GetEnvVar(ConfigurationKeys.AGENT_ENDPOINT),
+                    GetEnvVar(ConfigurationKeys.ServiceName),
+                    GetEnvVar(ConfigurationKeys.ServiceType),
+                    GetEnvVar(ConfigurationKeys.LogGroupName),
+                    GetEnvVar(ConfigurationKeys.LogStreamName),
+                    GetEnvVar(ConfigurationKeys.AgentEndpoint),
                     bufferSize,
                     GetEnvironmentOverride());
             }
@@ -34,7 +34,7 @@ public static IConfiguration Config
 
         private static Environments GetEnvironmentOverride()
         {
-            var environmentName = GetEnvVar(ConfigurationKeys.ENVIRONMENT_OVERRIDE);
+            var environmentName = GetEnvVar(ConfigurationKeys.EnvironmentOverride);
             if (string.IsNullOrEmpty(environmentName))
             {
                 return Environments.Unknown;
@@ -52,7 +52,7 @@ private static Environments GetEnvironmentOverride()
 
         private static string GetEnvVar(string key)
         {
-            var name = string.Join(string.Empty, ConfigurationKeys.ENV_VAR_PREFIX, "_", key);
+            var name = string.Join(string.Empty, ConfigurationKeys.EnvVarPrefix, "_", key);
             return EnvUtils.GetEnv(name);
         }
     }

src/Amazon.CloudWatch.EMF/Constants.cs

@@ -2,19 +2,19 @@ namespace Amazon.CloudWatch.EMF
 {
     public class Constants
     {
-        public const int MAX_DIMENSION_SET_SIZE = 30;
-        public const int MAX_DIMENSION_NAME_LENGTH = 250;
-        public const int MAX_DIMENSION_VALUE_LENGTH = 1024;
-        public const int MAX_METRIC_NAME_LENGTH = 1024;
-        public const int MAX_NAMESPACE_LENGTH = 256;
-        public const string VALID_NAMESPACE_REGEX = "^[a-zA-Z0-9._#:/-]+$";
+        public const int MaxDimensionSetSize = 30;
+        public const int MaxDimensionNameLength = 250;
+        public const int MaxDimensionValueLength = 1024;
+        public const int MaxMetricNameLength = 1024;
+        public const int MaxNamespaceLength = 256;
+        public const string ValidNamespaceRegex = "^[a-zA-Z0-9._#:/-]+$";
 
-        public const int DEFAULT_AGENT_PORT = 25888;
+        public const int DefaultAgentPort = 25888;
 
-        public const string UNKNOWN = "Unknown";
+        public const string Unknown = "Unknown";
 
-        public const int MAX_METRICS_PER_EVENT = 100;
+        public const int MaxMetricsPerEvent = 100;
 
-        public const string DEFAULT_NAMESPACE = "aws-embedded-metrics";
+        public const string DefaultNamespace = "aws-embedded-metrics";
     }
 }

src/Amazon.CloudWatch.EMF/Environment/AgentBasedEnvironment.cs

@@ -18,9 +18,9 @@ protected AgentBasedEnvironment(IConfiguration configuration, ILoggerFactory log
             _loggerFactory = loggerFactory;
         }
 
-        public virtual string Name => !string.IsNullOrEmpty(_configuration.ServiceName) ? _configuration.ServiceName : Constants.UNKNOWN;
+        public virtual string Name => !string.IsNullOrEmpty(_configuration.ServiceName) ? _configuration.ServiceName : Constants.Unknown;
 
-        public virtual string Type => !string.IsNullOrEmpty(_configuration.ServiceType) ? _configuration.ServiceType : Constants.UNKNOWN;
+        public virtual string Type => !string.IsNullOrEmpty(_configuration.ServiceType) ? _configuration.ServiceType : Constants.Unknown;
 
         public virtual string LogGroupName => !string.IsNullOrEmpty(_configuration.LogGroupName) ? _configuration.LogGroupName : Name + "_metrics";
 

src/Amazon.CloudWatch.EMF/Environment/EC2Environment.cs

@@ -103,7 +103,7 @@ public override string Type
                     return CFN_EC2_TYPE;
                 }
 
-                return Constants.UNKNOWN;
+                return Constants.Unknown;
             }
         }