build(testapps): playground for

- add testapps-fastapi
  - redis/httpx/mysql
- change plugin style

close #547

Author: eeliu

.gitignore

@@ -75,3 +75,4 @@ testapps/PHP/composer.phar
 wheelhouse/
 .clangd
 collector-agent/pinpoint-grpc-idl/
+*.so

collector-agent/start-collector-agent.sh

@@ -8,7 +8,7 @@ export PP_COLLECTOR_AGENT_STAT_PORT=9992
 export PP_COLLECTOR_AGENT_ISDOCKER=false
 # export PP_LOG_DIR=/tmp/
 export PP_Log_Level=DEBUG
-export PP_ADDRESS=0.0.0.0@9999
+export PP_ADDRESS=0.0.0.0@10000
 export GO_PATH=/home/pinpoint/go/bin
 export PATH=$PATH:$GO_PATH
 make && ./collector-agent

plugins/PY/pinpointPy/Common.py

@@ -19,17 +19,39 @@
 
 # Created by eeliu at 3/5/20
 
-from pinpointPy import Defines
-from pinpointPy import pinpoint
+from pinpointPy import Defines, pinpoint, logger
 from abc import ABCMeta, abstractmethod
 
-class PinTrace(object):
-    E_PER_REQ = 1
-    E_FUNCTION = 2
 
+class Trace:
     def __init__(self, name):
         self.name = name
 
+    def onBefore(self, *args, **kwargs):
+        raise NotImplementedError("onBefore")
+
+    def onEnd(self, ret):
+        raise NotImplementedError("onEnd")
+
+    def __call__(self, func):
+
+        def pinpointTrace(*args, **kwargs):
+            try:
+                args, kwargs = self.onBefore(*args, **kwargs)
+                ret = func(*args, **kwargs)
+            except Exception as e:
+                self.onException(e)
+                logger.info(f"{func.__name__} catch {e}")
+                raise e
+            finally:
+                return self.onEnd(ret)
+        return pinpointTrace
+
+
+class PinTrace(Trace):
+    E_PER_REQ = 1
+    E_FUNCTION = 2
+
     def isSample(self, args):
         '''
         if not root, no trace
@@ -42,28 +64,27 @@ def isSample(self, args):
 
     def onBefore(self, *args, **kwargs):
         pinpoint.with_trace()
-        return args,kwargs
+        return args, kwargs
 
     def onEnd(self, ret):
         pinpoint.end_trace()
 
     def onException(self, e):
-        raise NotImplementedError()
+        raise NotImplementedError("onException")
 
     def __call__(self, func):
         self.func_name = func.__name__
 
         def pinpointTrace(*args, **kwargs):
             if not self.isSample((args, kwargs)):
                 return func(*args, **kwargs)
-
-            ret = None
             try:
                 args, kwargs = self.onBefore(*args, **kwargs)
                 ret = func(*args, **kwargs)
                 return ret
             except Exception as e:
                 self.onException(e)
+                logger.info(f"{func.__name__} catch {e}")
                 raise e
             finally:
                 self.onEnd(ret)
@@ -72,6 +93,7 @@ def pinpointTrace(*args, **kwargs):
     def getFuncUniqueName(self):
         return self.name
 
+
 class PinHeader:
     def __init__(self) -> None:
         # Path field in pinpoint-web
@@ -117,7 +139,8 @@ def GetHeader(self,parenthost,parentname,url,...)->PinHeader:
     @abstractmethod
     def GetHeader(self, *args, **kwargs) -> PinHeader:
         return PinHeader()
-    
+
+
 class PinTransaction(PinTrace):
 
     def __init__(self, name: str, userGenHeaderCb: GenPinHeader):

plugins/PY/pinpointPy/CommonPlugin.py

@@ -15,24 +15,24 @@
 # ------------------------------------------------------------------------------
 
 
-from pinpointPy import Common
-from pinpointPy import Defines
-from pinpointPy import pinpoint
+from pinpointPy import Common, Defines, pinpoint
 
 
 class PinpointCommonPlugin(Common.PinTrace):
 
-    def onBefore(self,*args, **kwargs):
+    def onBefore(self, *args, **kwargs):
         super().onBefore(*args, **kwargs)
         ###############################################################
-        pinpoint.add_trace_header(Defines.PP_INTERCEPTOR_NAME, self.getFuncUniqueName())
-        pinpoint.add_trace_header(Defines.PP_SERVER_TYPE, Defines.PP_METHOD_CALL)
+        pinpoint.add_trace_header(
+            Defines.PP_INTERCEPTOR_NAME, self.getFuncUniqueName())
+        pinpoint.add_trace_header(
+            Defines.PP_SERVER_TYPE, Defines.PP_METHOD_CALL)
         arg = self.get_arg(*args, **kwargs)
         pinpoint.add_trace_header_v2(Defines.PP_ARGS, arg)
         ###############################################################
-        return args,kwargs
+        return args, kwargs
 
-    def onEnd(self,ret):
+    def onEnd(self, ret):
         ###############################################################
         pinpoint.add_trace_header_v2(Defines.PP_RETURN, str(ret))
         ###############################################################

plugins/PY/pinpointPy/Fastapi/AsyCommon.py

@@ -16,50 +16,52 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
-
 import asyncio
 
 from starlette_context import context
 
 from pinpointPy import pinpoint
 
 
-class AsynPinTrace(object):
+class TraceContext:
+    @staticmethod
+    def get_parent_id():
+        id = context.get('_pinpoint_id_', 0)
+        if id == 0:
+            return False, None
+        else:
+            return True, id
+
+    @staticmethod
+    def set_parent_id(id: int):
+        context['_pinpoint_id_'] = id
+
+
+class AsyncPinTrace:
 
     def __init__(self, name):
         self.name = name
 
-    def getCurrentId(self):
-        id = context['_pinpoint_id_']
-        if not id:
-            raise 'not found traceId'
-        else:
-            return id
-
     def onBefore(self, parentId, *args, **kwargs):
         traceId = pinpoint.with_trace(parentId)
-        # update global id
-        context['_pinpoint_id_'] = traceId
+        TraceContext.set_parent_id(traceId)
         return traceId, args, kwargs
 
     @staticmethod
     def isSample(*args, **kwargs):
-        try:
-            parentid = context.get('_pinpoint_id_', 0)
-            if parentid == 0:
-                return False, None
-            return True, parentid
-        except Exception as e:
-            return False, None
+        ret, id = TraceContext.get_parent_id()
+        if ret:
+            return True, id, args, kwargs
+        else:
+            return False, None, args, kwargs
 
     @classmethod
     def _isSample(cls, *args, **kwargs):
         return cls.isSample(*args, **kwargs)
 
     def onEnd(self, parentId, ret):
         parentId = pinpoint.end_trace(parentId)
-        context['_pinpoint_id_'] = parentId
+        TraceContext.set_parent_id(parentId)
 
     def onException(self, traceId, e):
         raise NotImplementedError()
@@ -69,20 +71,21 @@ def __call__(self, func):
 
         async def pinpointTrace(*args, **kwargs):
             ret = None
-            sampled, parentId = self._isSample(args, kwargs)
+            # avoiding variable missing
+            # use and return
+            sampled, parentId, nArgs, nKwargs = self._isSample(*args, **kwargs)
             if not sampled:
-                return await func(*args, **kwargs)
-
-            traceId, args, kwargs = self.onBefore(parentId, *args, **kwargs)
+                return await func(*nArgs, **nKwargs)
+            traceId, nArgs, nKwargs = self.onBefore(
+                parentId, *nArgs, **nKwargs)
             try:
-                ret = await func(*args, **kwargs)
+                ret = await func(*nArgs, **nKwargs)
                 return ret
             except Exception as e:
                 self.onException(traceId, e)
                 raise e
             finally:
                 self.onEnd(traceId, ret)
-
         return pinpointTrace
 
     def getFuncUniqueName(self):
@@ -91,7 +94,7 @@ def getFuncUniqueName(self):
 
 if __name__ == '__main__':
 
-    @AsynPinTrace('main')
+    @AsyncPinTrace('main')
     async def run(i):
         if i == 0:
             return

plugins/PY/pinpointPy/Fastapi/AsyCommonPlugin.py

@@ -15,12 +15,12 @@
 # ------------------------------------------------------------------------------
 
 
-from pinpointPy.Fastapi.AsyCommon import AsynPinTrace
+from pinpointPy.Fastapi.AsyCommon import AsyncPinTrace
 from pinpointPy import Defines
 from pinpointPy import pinpoint
 
 
-class CommonPlugin(AsynPinTrace):
+class CommonPlugin(AsyncPinTrace):
 
     def onBefore(self,parentId, *args, **kwargs):
         traceId,args,kwargs = super().onBefore(parentId,*args, **kwargs)

plugins/PY/pinpointPy/Fastapi/AsyRequestPlugin.py

@@ -18,12 +18,12 @@
 # ------------------------------------------------------------------------------
 
 
-from pinpointPy.Fastapi.AsyCommon import AsynPinTrace
+from pinpointPy.Fastapi.AsyCommon import AsyncPinTrace
 from pinpointPy import pinpoint
 from pinpointPy import Defines
 
 
-class AsyRequestPlugin(AsynPinTrace):
+class AsyRequestPlugin(AsyncPinTrace):
     def __init__(self, name):
         super().__init__(name)
 

plugins/PY/pinpointPy/Fastapi/FastAPIRequestPlugin.py

@@ -21,6 +21,7 @@
 from pinpointPy.Fastapi.AsyRequestPlugin import AsyRequestPlugin
 from pinpointPy import Defines, pinpoint
 import sys
+from fastapi import Response
 
 
 class FastAPIRequestPlugin(AsyRequestPlugin):
@@ -40,11 +41,24 @@ def onBefore(self, parentId, *args, **kwargs):
         self.request = request
         return traceId, args, kwargs
 
-    def onEnd(self, traceId, response):
-        ut = self.request.scope['root_path'] + self.request.scope['route'].path
+    def onEnd(self, traceId, response: Response):
+        # fix bug in in fastapi/docs
+        ut = '/'
+        if 'root_path' in self.request.scope:
+            ut += self.request.scope['root_path']
+        if 'route' in self.request.scope:
+            ut += self.request.scope['route'].path
+
         pinpoint.add_trace_header(Defines.PP_URL_TEMPLATED, ut, traceId)
 
         if 'unittest' in sys.modules.keys():
             response.headers["UT"] = ut
 
+        if response:
+            pinpoint.add_trace_header_v2(Defines.PP_HTTP_STATUS_CODE, str(
+                response.status_code), traceId)
+            if response.status_code >= 400:
+                pinpoint.mark_as_error(
+                    f'status_code:{response.status_code}', 'FastAPIRequestPlugin', 0, traceId)
+
         return super().onEnd(traceId, response)

plugins/PY/pinpointPy/Fastapi/PinTranscation.py

@@ -17,7 +17,7 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pinpointPy.Fastapi.AsyCommon import AsynPinTrace
+from pinpointPy.Fastapi.AsyCommon import AsyncPinTrace
 from pinpointPy import Defines,pinpoint
 from pinpointPy.Common import GenPinHeader
 from starlette_context import request_cycle_context
@@ -36,7 +36,7 @@ async def pinpointTrace(*args, **kwargs):
         return pinpointTrace
 
 
-class PinTransaction(AsynPinTrace):
+class PinTransaction(AsyncPinTrace):
 
     def __init__(self, name: str, userGenHeaderCb: GenPinHeader):
         """pinpointPy user entry point

plugins/PY/pinpointPy/Fastapi/_MotorMongo/__init__.py

@@ -20,17 +20,18 @@
 # create by eelu
 
 from pinpointPy.Interceptor import intercept_once
+from pinpointPy import logger
 
 
 @intercept_once
 def monkey_patch():
     try:
         from pymongo import monitoring
-        from .motorComandPlugins import CommandLogger
+        from .motorCommandPlugins import CommandLogger
         monitoring.register(CommandLogger())
     except ImportError as e:
         # do nothing
-        print(e)
+        logger.debug(f"not found pymongo. {e}")
 
 
 __all__ = ['monkey_patch']