From c7d165040ec870b42f444b0420cec568033b3a9c Mon Sep 17 00:00:00 2001
From: Ryan Tan <1265924+ryantanjunming@users.noreply.github.com>
Date: Fri, 10 May 2024 15:16:20 +0800
Subject: [PATCH] Add description (#158)

* default metrics type as CloudWatch_Metrics_OpenTelemetry070_WithAggregations

* examples set, add changelog

* expand readme with description

* add changelog

* remove slash

* fmt
---
 CHANGELOG.md                       | 1 +
 modules/firehose-metrics/README.md | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index bf12ff14..a8141157 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
 #### firehose-metrics
 ### 💡 Enhancements 
 - [cds-1198] set default type parameter to CloudWatch_Metrics_OpenTelemetry070_WithAggregations
+- add README description for aggregation
 
 ## v1.0.96
 #### **coralogix-aws-shipper**
diff --git a/modules/firehose-metrics/README.md b/modules/firehose-metrics/README.md
index b75815a1..3b1e0a43 100644
--- a/modules/firehose-metrics/README.md
+++ b/modules/firehose-metrics/README.md
@@ -198,7 +198,7 @@ then the CloudWatch metric stream must be configured with the same format, confi
 | <a name="input_subsystem_name"></a> [subsystem_name](#input\_subsystem_name) | The subsystem name of your application in Coralogix | `string` | n/a | yes |
 | <a name="input_cloudwatch_retention_days"></a> [cloudwatch\_retention\_days](#input\_cloudwatch_retention_days) | Days of retention in Cloudwatch retention days | `number` | n/a | no |
 | <a name="input_custom_domain"></a> [custom_domain](#input\_custom_domain) | Custom domain for Coralogix firehose integration endpoint (private.coralogix.net:8443) | `string` | `null` | no |
-| <a name="input_integration_type_metrics"></a> [integration\_type\_metrics](#input\_integration\_type\_metrics) | The integration type of the firehose delivery stream: `CloudWatch\_Metrics\_OpenTelemetry070` or `CloudWatch_Metrics\_OpenTelemetry070\_WithAggregations` | `string` | `"CloudWatch\_Metrics\_OpenTelemetry070"` | no |
+| <a name="input_integration_type_metrics"></a> [integration\_type\_metrics](#input\_integration\_type\_metrics) | The integration type of the firehose delivery stream: `CloudWatch_Metrics_OpenTelemetry070` or `CloudWatch_Metrics_OpenTelemetry070_WithAggregations`. For `_WithAggregations` choice, additional aggregations here are `_min`, `_max`, `_avg` recorded as gauges. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats-opentelemetry-translation.html | `string` | `"CloudWatch_Metrics_OpenTelemetry070_WithAggregations"` | no |
 | <a name="input_enable_cloudwatch_metricstream"></a> [enable\_cloudwatch\_metricstream](#input\_enable\_cloudwatch\_metricstream) | Should be true if you want to create a new Cloud Watch metric stream and attach it to Firehose | `bool` | `true` | no |
 | <a name="input_lambda_processor_enable"></a> [lambda_processor_enable](#input\_lambda_processor_enable) | Enable the lambda processor function. Set to false to remove the lambda and all associated resources. | `bool` | `true` | no |
 | <a name="input_output_format"></a> [output\_format](#input\_output\_format) | The output format of the cloudwatch metric stream: 'json' or 'opentelemetry0.7' | `string` | `"opentelemetry0.7"` | no |