feat(tencent): support tencent functions (#338)

Author: ranrib

epsagon/__init__.py

@@ -58,6 +58,7 @@ def _inner_wrapper(func):
     python_wrapper = dummy_python_wrapper  # pylint: disable=C0103
     flask_wrapper = dummy_wrapper  # pylint: disable=C0103
     gcp_wrapper = dummy_wrapper  # pylint: disable=C0103
+    tencent_function_wrapper = dummy_wrapper  # pylint: disable=C0103
 else:
     # Environments.
     from .wrappers import (
@@ -66,7 +67,8 @@ def _inner_wrapper(func):
         chalice_wrapper,
         azure_wrapper,
         python_wrapper,
-        gcp_wrapper
+        gcp_wrapper,
+        tencent_function_wrapper
     )
 
     # Frameworks.
@@ -93,6 +95,7 @@ def _inner_wrapper(func):
     'flask_wrapper',
     'wrapper',
     'gcp_wrapper',
+    'tencent_function_wrapper',
     'chalice_wrapper',
     'auto_load',
     'measure',

epsagon/events/qcloud_cos.py

@@ -0,0 +1,75 @@
+"""
+Cloud Object Storage events module.
+"""
+
+from __future__ import absolute_import
+from uuid import uuid4
+import traceback
+
+from ..event import BaseEvent
+from ..trace import trace_factory
+
+
+class COSEvent(BaseEvent):
+    """
+    Represents base Cloud Object Storage event.
+    """
+    ORIGIN = 'tencent-cos'
+    RESOURCE_TYPE = 'cos'
+
+    # pylint: disable=W0613
+    def __init__(self, wrapped, instance, args, kwargs, start_time, response,
+                 exception):
+        """
+        Initialize the Cloud Object Storage event
+        :param wrapped: wrapt's wrapped
+        :param instance: wrapt's instance
+        :param args: wrapt's args
+        :param kwargs: wrapt's kwargs
+        :param start_time: Start timestamp (epoch)
+        :param response: response data
+        :param exception: Exception (if happened)
+        """
+
+        super(COSEvent, self).__init__(start_time)
+        self.event_id = 'cos-{}'.format(str(uuid4()))
+        self.resource['name'] = kwargs['bucket']
+        self.resource['operation'] = kwargs['method']
+        self.resource['metadata'] = {
+            # pylint: disable=protected-access
+            'tencent.region': instance._conf._region,
+            'tencent.cos.object_key': kwargs['url'].split('myqcloud.com/')[-1],
+        }
+        if response:
+            self.resource['metadata'].update({
+                'tencent.cos.request_id': response.headers['x-cos-request-id'],
+                'tencent.status_code': response.status_code,
+            })
+
+        if exception is not None:
+            self.resource['metadata'].update({
+                'tencent.cos.request_id': exception.get_request_id(),
+                'tencent.status_code': exception.get_status_code(),
+            })
+            self.set_exception(exception, traceback.format_exc())
+
+
+class COSEventFactory(object):
+    """
+    Factory class, generates Cloud Object Storage event.
+    """
+    @staticmethod
+    def create_event(wrapped, instance, args, kwargs, start_time, response,
+                     exception):
+        """
+        Create a Cloud Object Storage event.
+        """
+        trace_factory.add_event(COSEvent(
+            wrapped,
+            instance,
+            args,
+            kwargs,
+            start_time,
+            response,
+            exception
+        ))

epsagon/http_filters.py

@@ -32,6 +32,7 @@
     str.endswith: [
         'epsagon.com',
         '.amazonaws.com',
+        '.myqcloud.com',
     ],
     str.__contains__: [
         'accounts.google.com',

epsagon/modules/qcloud_cos.py

@@ -0,0 +1,32 @@
+"""
+Cloud Object Storage patcher module.
+"""
+
+from __future__ import absolute_import
+import wrapt
+from epsagon.modules.general_wrapper import wrapper
+from ..events.qcloud_cos import COSEventFactory
+
+
+def _wrapper(wrapped, instance, args, kwargs):
+    """
+    Cloud Object Storage wrapper for Tencent instrumentation.
+    :param wrapped: wrapt's wrapped
+    :param instance: wrapt's instance
+    :param args: wrapt's args
+    :param kwargs: wrapt's kwargs
+    :return: None
+    """
+    return wrapper(COSEventFactory, wrapped, instance, args, kwargs)
+
+
+def patch():
+    """
+    patch module.
+    :return: None
+    """
+    wrapt.wrap_function_wrapper(
+        'qcloud_cos',
+        'CosS3Client.send_request',
+        _wrapper
+    )

epsagon/runners/tencent_function.py

@@ -0,0 +1,49 @@
+"""
+Runner for Tencent SCF.
+"""
+
+from __future__ import absolute_import
+from ..event import BaseEvent
+from .. import constants
+from ..common import ErrorCode
+
+
+class TencentFunctionRunner(BaseEvent):
+    """
+    Represents Tencent SCF event runner.
+    """
+    ORIGIN = 'runner'
+    RESOURCE_TYPE = 'tencent_function'
+    OPERATION = 'invoke'
+
+    def __init__(self, start_time, context):
+        """
+        Initialize.
+        :param start_time: event's start time (epoch)
+        :param context: SCF's context (passed from entry point)
+        """
+        super(TencentFunctionRunner, self).__init__(start_time)
+
+        # Creating a unique ID for local runs.
+        self.event_id = context['request_id']
+        self.resource['name'] = context['function_name']
+        self.resource['operation'] = self.OPERATION
+
+        self.resource['metadata'].update({
+            'tencent.scf.version': context['function_version'],
+            'tencent.scf.memory': context['memory_limit_in_mb'],
+            'tencent.scf.cold_start': constants.COLD_START,
+            'tencent.namespace': context['namespace'],
+            'tencent.uin': context['tencentcloud_uin'],
+            'tencent.app_id': context['tencentcloud_appid'],
+            'tencent.region': context['tencentcloud_region'],
+        })
+
+    def set_timeout(self):
+        """
+        Sets timeout error code.
+        :return: None
+        """
+        # Don't override exceptions
+        if self.error_code != ErrorCode.EXCEPTION:
+            self.error_code = ErrorCode.TIMEOUT