changing the name to AmazonCloudWatchEMF

aws_lambda_powertools/metrics/__init__.py

@@ -8,7 +8,12 @@
     SchemaValidationError,
 )
 from aws_lambda_powertools.metrics.metric import single_metric
-from aws_lambda_powertools.metrics.provider.cloudwatch_emf import CloudWatchEMF, EphemeralMetrics, Metrics
+from aws_lambda_powertools.metrics.provider.amazon_cloudwatch_emf import (
+    AmazonCloudWatchEMF,
+    EphemeralAmazonCloudWatchEMF,
+    EphemeralMetrics,
+    Metrics,
+)
 
 __all__ = [
     "Metrics",
@@ -20,5 +25,6 @@
     "MetricResolutionError",
     "SchemaValidationError",
     "MetricValueError",
-    "CloudWatchEMF",
+    "AmazonCloudWatchEMF",
+    "EphemeralAmazonCloudWatchEMF",
 ]

aws_lambda_powertools/metrics/metrics.py

@@ -1,4 +1,9 @@
 # NOTE: keeps for compatibility
-from aws_lambda_powertools.metrics.provider.cloudwatch_emf import CloudWatchEMF, EphemeralMetrics, Metrics
+from aws_lambda_powertools.metrics.provider.amazon_cloudwatch_emf import (
+    AmazonCloudWatchEMF,
+    EphemeralAmazonCloudWatchEMF,
+    EphemeralMetrics,
+    Metrics,
+)
 
-__all__ = ["Metrics", "EphemeralMetrics", "CloudWatchEMF"]
+__all__ = ["Metrics", "EphemeralMetrics", "AmazonCloudWatchEMF", "EphemeralAmazonCloudWatchEMF"]

aws_lambda_powertools/metrics/provider/__init__.py

@@ -1,9 +1,10 @@
-from aws_lambda_powertools.metrics.provider.base import MetricsBase, MetricsProviderBase
-from aws_lambda_powertools.metrics.provider.cloudwatch_emf import (
-    CloudWatchEMF,
+from aws_lambda_powertools.metrics.provider.amazon_cloudwatch_emf import (
+    AmazonCloudWatchEMF,
+    EphemeralAmazonCloudWatchEMF,
     EphemeralMetrics,
     Metrics,
 )
+from aws_lambda_powertools.metrics.provider.base import MetricsBase, MetricsProviderBase
 from aws_lambda_powertools.metrics.provider.datadog_provider_draft import (
     DataDogMetrics,
     DataDogProvider,
@@ -19,6 +20,8 @@
     "DataDogMetrics",
     "DataDogProvider",
     "Metrics",
+    "AmazonCloudWatchEMF",
+    "EphemeralAmazonCloudWatchEMF",
     "EphemeralMetrics",
     "CloudWatchEMF",
     "OTLPProvider",

aws_lambda_powertools/metrics/provider/cloudwatch_emf.py → aws_lambda_powertools/metrics/provider/amazon_cloudwatch_emf.py

@@ -122,7 +122,7 @@ def clear_metrics(self) -> None:
 
 
 # add alias for original EMF format to make the provider more explicit
-CloudWatchEMF = Metrics
+AmazonCloudWatchEMF = Metrics
 
 
 class EphemeralMetrics(MetricManager):
@@ -134,5 +134,49 @@ class EphemeralMetrics(MetricManager):
     - Create the same metrics with different dimensions more than once
     """
 
+    _dimensions: Dict[str, str] = {}
+    _default_dimensions: Dict[str, Any] = {}
+
     def __init__(self, service: str | None = None, namespace: str | None = None):
+        self.default_dimensions = self._default_dimensions
+        self.dimension_set = self._dimensions
+
+        self.dimension_set.update(**self._default_dimensions)
         super().__init__(namespace=namespace, service=service)
+
+    def set_default_dimensions(self, **dimensions) -> None:
+        """Persist dimensions across Lambda invocations
+
+        Parameters
+        ----------
+        dimensions : Dict[str, Any], optional
+            metric dimensions as key=value
+
+        Example
+        -------
+        **Sets some default dimensions that will always be present across metrics and invocations**
+
+            from aws_lambda_powertools import Metrics
+
+            metrics = Metrics(namespace="ServerlessAirline", service="payment")
+            metrics.set_default_dimensions(environment="demo", another="one")
+
+            @metrics.log_metrics()
+            def lambda_handler():
+                return True
+        """
+        for name, value in dimensions.items():
+            self.add_dimension(name, value)
+
+        self.default_dimensions.update(**dimensions)
+
+    def clear_default_dimensions(self) -> None:
+        self.default_dimensions.clear()
+
+    def clear_metrics(self) -> None:
+        super().clear_metrics()
+        # re-add default dimensions
+        self.set_default_dimensions(**self.default_dimensions)
+
+
+EphemeralAmazonCloudWatchEMF = EphemeralMetrics

tests/functional/test_metrics.py

@@ -20,7 +20,7 @@
     MetricManager,
     reset_cold_start_flag,
 )
-from aws_lambda_powertools.metrics.provider import CloudWatchEMF, MetricsBase, MetricsProviderBase
+from aws_lambda_powertools.metrics.provider import AmazonCloudWatchEMF, MetricsBase, MetricsProviderBase
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -1260,7 +1260,7 @@ def flush_metrics(self, raise_on_empty_metrics: bool = False) -> None:
 
 
 def test_cloudwatch_emf(namespace):
-    assert CloudWatchEMF == Metrics
+    assert AmazonCloudWatchEMF == Metrics
 
 
 def test_metrics_provider_basic(capsys, metrics_provider, metric):