first implementation of the metrics logger and env provider

Author: jaredcnance

README.md

@@ -5,19 +5,3 @@
 ```
 pip install tox
 ```
-
-https://github.com/nvbn/thefuck/blob/master/tox.ini
-
-# Resources
-
-- Versioneer: https://github.com/quantopian/zipline/blob/master/versioneer.py
-- Docker
-
-- Development Guidelines: https://www.zipline.io/development-guidelines
-- Code Style: flake8
-- Testing py.test
-- Deployment
-  - pandoc
-  - https://github.com/nvbn/thefuck/blob/master/release.py
-- Type Checking
-  - mypy https://github.com/open-telemetry/opentelemetry-python/blob/master/mypy.ini

aws_embedded_metrics/config/environment_configuration_provider.py

@@ -1,5 +1,4 @@
 import os
-from typing import TypeVar
 from aws_embedded_metrics.config.configuration import Configuration
 
 ENV_VAR_PREFIX = "AWS_EMF"
@@ -11,8 +10,6 @@
 LOG_STREAM_NAME = "LOG_STREAM_NAME"
 AGENT_ENDPOINT = "AGENT_ENDPOINT"
 
-T = TypeVar("T")
-
 
 class EnvironmentConfigurationProvider:
     """

aws_embedded_metrics/environment/__init__.py

@@ -0,0 +1,35 @@
+import abc
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.sinks import Sink
+
+
+class Environment(abc.ABC):
+    @staticmethod
+    @abc.abstractmethod
+    def probe() -> bool:
+        """Determines whether or not we are executing in this environment"""
+
+    @staticmethod
+    @abc.abstractmethod
+    def get_name() -> str:
+        """Get the environment name. This will be used to set the ServiceName dimension."""
+
+    @staticmethod
+    @abc.abstractmethod
+    def get_type() -> str:
+        """Get the environment type. This will be used to set the ServiceType dimension."""
+
+    @staticmethod
+    @abc.abstractmethod
+    def get_log_group_name() -> str:
+        """Get log group name. This will be used to set the LogGroup dimension."""
+
+    @staticmethod
+    @abc.abstractmethod
+    def configure_context(context: MetricsContext) -> None:
+        """Configure the context with environment properties."""
+
+    @staticmethod
+    @abc.abstractmethod
+    def get_sink() -> Sink:
+        """Create the appropriate sink for this environment."""

aws_embedded_metrics/environment/environment_provider.py

@@ -0,0 +1,9 @@
+import abc
+from aws_embedded_metrics.environment import Environment
+
+
+class EnvironmentProvider(abc.ABC):
+    @staticmethod
+    @abc.abstractmethod
+    async def get() -> Environment:
+        """Determine the current runtime environment"""

aws_embedded_metrics/logger/metrics_context.py

@@ -74,7 +74,7 @@ def set_default_dimensions(self, default_dimensions: Dict) -> None:
         to the context.
         If no custom dimensions are specified, the metrics will be emitted
         with the defaults.
-        If custome dimensions are specified, they will be prepended with
+        If custom dimensions are specified, they will be prepended with
         the default dimensions.
         """
         self.default_dimensions = default_dimensions
@@ -113,3 +113,7 @@ def create_copy_with_context(self) -> "MetricsContext":
         return MetricsContext(
             self.namespace, new_properties, new_dimensions, new_default_dimensions
         )
+
+    @staticmethod
+    def empty() -> "MetricsContext":
+        return MetricsContext()

aws_embedded_metrics/logger/metrics_logger.py

@@ -0,0 +1,39 @@
+from aws_embedded_metrics.environment import Environment
+from aws_embedded_metrics.environment.environment_provider import EnvironmentProvider
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.config import get_config
+
+Config = get_config()
+
+
+class MetricsLogger:
+    def __init__(
+        self, env_provider: EnvironmentProvider, context: MetricsContext = None
+    ):
+        self.env_provider = env_provider
+        self.context: MetricsContext = context or MetricsContext.empty()
+
+    async def flush(self) -> None:
+        # resolve the environment and get the sink
+        # MOST of the time this will run synchonrously
+        # This only runs asynchronously if executing for the
+        # first time in a non-lambda environment
+        environment = await self.env_provider.get()
+
+        self.__configureContextForEnvironment(environment)
+        sink = environment.get_sink()
+
+        # accept and reset the context
+        sink.accept(self.context)
+        self.context = MetricsContext.empty()
+
+    def __configureContextForEnvironment(self, env: Environment) -> None:
+        default_dimensions = {
+            # LogGroup name will entirely depend on the environment since there
+            # are some cases where the LogGroup cannot be configured (e.g. Lambda)
+            "log_group": env.get_log_group_name(),
+            "service_name": Config.service_name or env.get_name(),
+            "service_type": Config.service_type or env.get_type(),
+        }
+        self.context.set_default_dimensions(default_dimensions)
+        env.configure_context(self.context)

aws_embedded_metrics/sinks/__init__.py

@@ -0,0 +1,14 @@
+import abc
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+
+
+class Sink(abc.ABC):
+    """The mechanism by which logs are sent to their destination."""
+
+    @abc.abstractmethod
+    def name(self) -> str:
+        """The name of the sink."""
+
+    @abc.abstractmethod
+    def accept(self, context: MetricsContext) -> None:
+        """Flushes the metrics context to the sink."""

setup.py

@@ -7,26 +7,20 @@
     name="aws-embedded-metrics",
     version="0.0.1",
     author="Amazon Web Services",
-    author_email="[email protected]",
-
+    author_email="[email protected]",
     description="AWS Embedded Metrics Package",
     long_description=long_description,
     long_description_content_type="text/markdown",
-
-    keywords='aws xray sdk',
-
+    keywords="aws logs metrics emf",
     url="https://github.com/awslabs/aws-embedded-metrics-python",
-
     classifiers=[
         "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
-        'Development Status :: 5 - Production/Stable',
-        'Intended Audience :: Developers',
-        'Natural Language :: English',
-        'License :: OSI Approved :: Apache Software License',
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Natural Language :: English",
+        "License :: OSI Approved :: Apache Software License",
     ],
-
-    packages=find_packages(exclude=['tests*']),
-    include_package_data=True
+    packages=find_packages(exclude=["tests*"]),
+    include_package_data=True,
 )