add full support for Lambda functions

Author: jaredcnance

aws_embedded_metrics/constants.py

@@ -1 +1,15 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 DEFAULT_NAMESPACE = "aws-embedded-metrics"
+MAX_DIMENSIONS = 10

aws_embedded_metrics/environment/environment_detector.py

@@ -0,0 +1,20 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.environment import Environment
+from aws_embedded_metrics.environment.lambda_environment import LambdaEnvironment
+
+
+async def resolve_environment() -> Environment:
+    # TODO: this should support agent-based environments
+    return LambdaEnvironment()

aws_embedded_metrics/environment/environment_provider.py

@@ -0,0 +1,61 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.environment import Environment
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.sinks import Sink
+from aws_embedded_metrics.sinks.lambda_sink import LambdaSink
+import os
+
+
+def get_env(key: str) -> str:
+    if key in os.environ:
+        return os.environ[key]
+    return ""
+
+
+sink = LambdaSink()
+
+
+class LambdaEnvironment(Environment):
+    @staticmethod
+    def probe() -> bool:
+        return len(get_env("AWS_LAMBDA_FUNCTION_NAME")) > 0
+
+    @staticmethod
+    def get_name() -> str:
+        return LambdaEnvironment.get_log_group_name()
+
+    @staticmethod
+    def get_type() -> str:
+        return "AWS::Lambda::Function"
+
+    @staticmethod
+    def get_log_group_name() -> str:
+        return get_env("AWS_LAMBDA_FUNCTION_NAME")
+
+    @staticmethod
+    def configure_context(context: MetricsContext) -> None:
+        context.set_property("executionEnvironment", get_env("AWS_EXECUTION_ENV"))
+        context.set_property("memorySize", get_env("AWS_LAMBDA_FUNCTION_MEMORY_SIZE"))
+        context.set_property("functionVersion", get_env("AWS_LAMBDA_FUNCTION_VERSION"))
+        context.set_property("logStreamId", get_env("AWS_LAMBDA_LOG_STREAM_NAME"))
+        trace_id = get_env("_X_AMZN_TRACE_ID")
+
+        if len(trace_id) > 0 and "Sampled=1" in trace_id:
+            context.set_property("traceId", trace_id)
+
+    @staticmethod
+    def get_sink() -> Sink:
+        """Create the appropriate sink for this environment."""
+        return sink

aws_embedded_metrics/environment/lambda_environment.py

@@ -0,0 +1,51 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.logger.metrics_logger_factory import create_metrics_logger
+import inspect
+import asyncio
+from functools import wraps
+
+
+def metric_scope(fn):  # type: ignore
+    logger = create_metrics_logger()
+
+    if asyncio.iscoroutinefunction(fn):
+
+        @wraps(fn)
+        async def wrapper(*args, **kwargs):  # type: ignore
+            if "metrics" in inspect.signature(fn).parameters:
+                kwargs["metrics"] = logger
+            try:
+                return await fn(*args, **kwargs)
+            except Exception as e:
+                raise e
+            finally:
+                await logger.flush()
+
+        return wrapper
+    else:
+
+        @wraps(fn)
+        def wrapper(*args, **kwargs):  # type: ignore
+            if "metrics" in inspect.signature(fn).parameters:
+                kwargs["metrics"] = logger
+            try:
+                return fn(*args, **kwargs)
+            except Exception as e:
+                raise e
+            finally:
+                loop = asyncio.get_event_loop()
+                loop.run_until_complete(logger.flush())
+
+        return wrapper

aws_embedded_metrics/logger/__init__.py

@@ -1,25 +1,39 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 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
-from typing import Any, Dict
+from typing import Any, Awaitable, Callable, Dict
 
 Config = get_config()
 
 
 class MetricsLogger:
     def __init__(
-        self, env_provider: EnvironmentProvider, context: MetricsContext = None
+        self,
+        resolve_environment: Callable[..., Awaitable[Environment]],
+        context: MetricsContext = None,
     ):
-        self.env_provider = env_provider
+        self.resolve_environment = resolve_environment
         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()
+        environment = await self.resolve_environment()
 
         self.__configureContextForEnvironment(environment)
         sink = environment.get_sink()
@@ -56,4 +70,6 @@ def put_metric(self, key: str, value: float, unit: str = "None") -> "MetricsLogg
         return self
 
     def new(self) -> "MetricsLogger":
-        return MetricsLogger(self.env_provider, self.context.create_copy_with_context())
+        return MetricsLogger(
+            self.resolve_environment, self.context.create_copy_with_context()
+        )

aws_embedded_metrics/logger/metrics_logger.py

@@ -0,0 +1,22 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.logger.metrics_logger import MetricsLogger
+from aws_embedded_metrics.environment.environment_detector import resolve_environment
+
+
+def create_metrics_logger() -> MetricsLogger:
+    context = MetricsContext.empty()
+    logger = MetricsLogger(resolve_environment, context)
+    return logger

aws_embedded_metrics/logger/metrics_logger_factory.py

@@ -0,0 +1,22 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import abc
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+
+
+class Serializer(abc.ABC):
+    @staticmethod
+    @abc.abstractmethod
+    def serialize(context: MetricsContext) -> str:
+        """Flushes the metrics context to the sink."""

aws_embedded_metrics/serializers/__init__.py

@@ -0,0 +1,57 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.serializers import Serializer
+from aws_embedded_metrics.constants import MAX_DIMENSIONS
+import json
+from typing import Dict, List
+
+
+class LogSerializer(Serializer):
+    @staticmethod
+    def serialize(context: MetricsContext) -> str:
+        dimension_keys = []
+        dimensions_properties: Dict[str, str] = {}
+
+        for dimension_set in context.get_dimensions():
+            keys = list(dimension_set.keys())
+            dimension_keys.append(keys[0:MAX_DIMENSIONS])
+            dimensions_properties = {**dimensions_properties, **dimension_set}
+
+        metric_pointers: List[Dict[str, str]] = []
+
+        metric_definitions = {
+            "Dimensions": dimension_keys,
+            "Metrics": metric_pointers,
+            "Namespace": context.namespace,
+        }
+        cloud_watch_metrics = [metric_definitions]
+
+        body = {
+            **dimensions_properties,
+            **context.properties,
+            "CloudWatchMetrics": cloud_watch_metrics,
+            "Version": "0",
+        }
+
+        for metric_name, metric in context.metrics.items():
+
+            if len(metric.values) == 1:
+                body[metric_name] = metric.values[0]
+            else:
+                body[metric_name] = metric.values
+
+            metric_pointers.append({"Name": metric_name, "Unit": metric.unit})
+
+        return json.dumps(body)

aws_embedded_metrics/serializers/log_serializer.py

@@ -1,12 +1,26 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 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."""
 
+    @staticmethod
     @abc.abstractmethod
-    def name(self) -> str:
+    def name() -> str:
         """The name of the sink."""
 
     @abc.abstractmethod

aws_embedded_metrics/sinks/__init__.py

@@ -0,0 +1,29 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from aws_embedded_metrics.logger.metrics_context import MetricsContext
+from aws_embedded_metrics.sinks import Sink
+from aws_embedded_metrics.serializers import Serializer
+from aws_embedded_metrics.serializers.log_serializer import LogSerializer
+
+
+class LambdaSink(Sink):
+    def __init__(self, serializer: Serializer = LogSerializer()):
+        self.serializer = serializer
+
+    def accept(self, context: MetricsContext) -> None:
+        print(self.serializer.serialize(context))
+
+    @staticmethod
+    def name() -> str:
+        return "LambdaSink"

aws_embedded_metrics/sinks/lambda_sink.py

@@ -0,0 +1,11 @@
+# Lambda Function Example
+
+1. Edit the function.py example as desired
+2. Create a lambda function
+3. Run the deploy script providing the ARN and region
+
+```sh
+./deploy.sh arn:aws:lambda:<REGION>:<ACCOUNT>:function:<FUNCTION_NAME> <REGION>
+# example:
+# ./deploy.sh arn:aws:lambda:us-east-1:123456789012:function:MyFunction us-east-1
+```