Allow CloudWatch namespace to be specifiable via environment variable (#28)

Allow CloudWatch namespace to be specifiable via environment variable

Co-authored-by: Jared Nance <[email protected]>

Author: ridha

README.md

@@ -231,6 +231,25 @@ Config.log_stream_name = "LogStreamName";
 AWS_EMF_LOG_STREAM_NAME = LogStreamName;
 ```
 
+**NameSpace**: Overrides the CloudWatch [namespace](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). If not set, a default value of aws-embedded-metrics will be used.
+
+Requirements:
+
+- Name Length 1-512 characters
+- Name must be ASCII characters only
+
+Example:
+
+```py
+# in process
+from aws_embedded_metrics.config import get_config
+Config = get_config()
+Config.namespace = "MyApplication";
+
+# environment
+AWS_EMF_NAMESPACE = MyApplication;
+```
+
 ## Examples
 
 Check out the [examples](https://github.com/awslabs/aws-embedded-metrics-python/tree/master/examples) directory to get started.

aws_embedded_metrics/config/configuration.py

@@ -22,6 +22,7 @@ def __init__(
         log_stream_name: str,
         agent_endpoint: str,
         ec2_metadata_endpoint: str = None,
+        namespace: str = None,
     ):
         self.debug_logging_enabled = debug_logging_enabled
         self.service_name = service_name
@@ -30,3 +31,4 @@ def __init__(
         self.log_stream_name = log_stream_name
         self.agent_endpoint = agent_endpoint
         self.ec2_metadata_endpoint = ec2_metadata_endpoint
+        self.namespace = namespace

aws_embedded_metrics/config/environment_configuration_provider.py

@@ -23,6 +23,7 @@
 LOG_STREAM_NAME = "LOG_STREAM_NAME"
 AGENT_ENDPOINT = "AGENT_ENDPOINT"
 EC2_METADATA_ENDPOINT = "EC2_METADATA_ENDPOINT"
+NAMESPACE = "NAMESPACE"
 
 
 class EnvironmentConfigurationProvider:
@@ -39,6 +40,7 @@ def get_configuration(self) -> Configuration:
             self.__get_env_var(LOG_STREAM_NAME),
             self.__get_env_var(AGENT_ENDPOINT),
             self.__get_env_var(EC2_METADATA_ENDPOINT),
+            self.__get_env_var(NAMESPACE),
         )
 
     @staticmethod

aws_embedded_metrics/logger/metrics_context.py

@@ -13,6 +13,7 @@
 
 
 from aws_embedded_metrics import constants, utils
+from aws_embedded_metrics.config import get_config
 from aws_embedded_metrics.logger.metric import Metric
 from typing import List, Dict, Any
 
@@ -30,7 +31,7 @@ def __init__(
         default_dimensions: Dict[str, str] = None,
     ):
 
-        self.namespace: str = namespace or constants.DEFAULT_NAMESPACE
+        self.namespace: str = namespace or get_config().namespace or constants.DEFAULT_NAMESPACE
         self.properties: Dict[str, Any] = properties or {}
         self.dimensions: List[Dict[str, str]] = dimensions or []
         self.default_dimensions: Dict[str, str] = default_dimensions or {}

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="aws-embedded-metrics",
-    version="1.0.1b3",
+    version="1.0.1b4",
     author="Amazon Web Services",
     author_email="[email protected]",
     description="AWS Embedded Metrics Package",

tests/config/test_config.py

@@ -1,6 +1,5 @@
 from aws_embedded_metrics import config
 from faker import Faker
-import os
 from importlib import reload
 
 
@@ -14,7 +13,7 @@ def get_config():
     return config.get_config()
 
 
-def test_can_get_config_from_environment():
+def test_can_get_config_from_environment(monkeypatch):
     # arrange
     debug_enabled = True
     service_name = fake.word()
@@ -23,14 +22,16 @@ def test_can_get_config_from_environment():
     log_stream = fake.word()
     agent_endpoint = fake.word()
     ec2_metadata_endpoint = fake.word()
+    namespace = fake.word()
 
-    os.environ["AWS_EMF_ENABLE_DEBUG_LOGGING"] = str(debug_enabled)
-    os.environ["AWS_EMF_SERVICE_NAME"] = service_name
-    os.environ["AWS_EMF_SERVICE_TYPE"] = service_type
-    os.environ["AWS_EMF_LOG_GROUP_NAME"] = log_group
-    os.environ["AWS_EMF_LOG_STREAM_NAME"] = log_stream
-    os.environ["AWS_EMF_AGENT_ENDPOINT"] = agent_endpoint
-    os.environ["AWS_EMF_EC2_METADATA_ENDPOINT"] = ec2_metadata_endpoint
+    monkeypatch.setenv("AWS_EMF_ENABLE_DEBUG_LOGGING", str(debug_enabled))
+    monkeypatch.setenv("AWS_EMF_SERVICE_NAME", service_name)
+    monkeypatch.setenv("AWS_EMF_SERVICE_TYPE", service_type)
+    monkeypatch.setenv("AWS_EMF_LOG_GROUP_NAME", log_group)
+    monkeypatch.setenv("AWS_EMF_LOG_STREAM_NAME", log_stream)
+    monkeypatch.setenv("AWS_EMF_AGENT_ENDPOINT", agent_endpoint)
+    monkeypatch.setenv("AWS_EMF_EC2_METADATA_ENDPOINT", ec2_metadata_endpoint)
+    monkeypatch.setenv("AWS_EMF_NAMESPACE", namespace)
 
     # act
     result = get_config()
@@ -43,17 +44,19 @@ def test_can_get_config_from_environment():
     assert result.log_stream_name == log_stream
     assert result.agent_endpoint == agent_endpoint
     assert result.ec2_metadata_endpoint == ec2_metadata_endpoint
+    assert result.namespace == namespace
 
 
-def test_can_override_config():
+def test_can_override_config(monkeypatch):
     # arrange
-    os.environ["AWS_EMF_ENABLE_DEBUG_LOGGING"] = str(True)
-    os.environ["AWS_EMF_SERVICE_NAME"] = fake.word()
-    os.environ["AWS_EMF_SERVICE_TYPE"] = fake.word()
-    os.environ["AWS_EMF_LOG_GROUP_NAME"] = fake.word()
-    os.environ["AWS_EMF_LOG_STREAM_NAME"] = fake.word()
-    os.environ["AWS_EMF_AGENT_ENDPOINT"] = fake.word()
-    os.environ["AWS_EMF_EC2_METADATA_ENDPOINT"] = fake.word()
+    monkeypatch.setenv("AWS_EMF_ENABLE_DEBUG_LOGGING", str(True))
+    monkeypatch.setenv("AWS_EMF_SERVICE_NAME", fake.word())
+    monkeypatch.setenv("AWS_EMF_SERVICE_TYPE", fake.word())
+    monkeypatch.setenv("AWS_EMF_LOG_GROUP_NAME", fake.word())
+    monkeypatch.setenv("AWS_EMF_LOG_STREAM_NAME", fake.word())
+    monkeypatch.setenv("AWS_EMF_AGENT_ENDPOINT", fake.word())
+    monkeypatch.setenv("AWS_EMF_EC2_METADATA_ENDPOINT", fake.word())
+    monkeypatch.setenv("AWS_EMF_NAMESPACE", fake.word())
 
     config = get_config()
 
@@ -64,6 +67,7 @@ def test_can_override_config():
     log_stream = fake.word()
     agent_endpoint = fake.word()
     ec2_metadata_endpoint = fake.word()
+    namespace = fake.word()
 
     # act
     config.debug_logging_enabled = debug_enabled
@@ -73,6 +77,7 @@ def test_can_override_config():
     config.log_stream_name = log_stream
     config.agent_endpoint = agent_endpoint
     config.ec2_metadata_endpoint = ec2_metadata_endpoint
+    config.namespace = namespace
 
     # assert
     assert config.debug_logging_enabled == debug_enabled
@@ -82,3 +87,4 @@ def test_can_override_config():
     assert config.log_stream_name == log_stream
     assert config.agent_endpoint == agent_endpoint
     assert config.ec2_metadata_endpoint == ec2_metadata_endpoint
+    assert config.namespace == namespace

tests/logger/test_metrics_context.py

@@ -1,7 +1,10 @@
+from aws_embedded_metrics import config
 from aws_embedded_metrics.logger.metrics_context import MetricsContext
 from aws_embedded_metrics import utils
+from aws_embedded_metrics.constants import DEFAULT_NAMESPACE
 from _pytest.monkeypatch import MonkeyPatch
 import pytest
+from importlib import reload
 from faker import Faker
 
 fake = Faker()
@@ -16,12 +19,16 @@ def mock_time():
 
 
 def test_can_create_context_with_no_arguments(mock_time):
+    # reload the configuration module since it is loaded on
+    # startup and cached
+    reload(config)
+
     # arrange
     # act
     context = MetricsContext()
 
     # assert
-    assert context.namespace == "aws-embedded-metrics"
+    assert context.namespace == DEFAULT_NAMESPACE
     assert context.meta == {"Timestamp": mock_time}
     assert context.properties == {}
     assert context.dimensions == []