feat: add sw_grpc plugin (#362)

Author: tsonglew

CHANGELOG.md

@@ -6,6 +6,9 @@
   - Drop support for 3.7 (#356)
   - Support sampling rate setup. Provide `SW_SAMPLE_N_PER_3_SECS` environment variable to control it (#357)
 
+- Plugins:
+  - Add gRPC plugin (#362)
+
 - Fixes:
   - Fix: user/password replacement is not allowed for relative URLs (#349)
   - Fix pulsar client does not support init arguments other than service_url (#351)

docs/en/setup/Configuration.md

@@ -97,6 +97,7 @@ export SW_AGENT_YourConfiguration=YourValue
 | plugin_fastapi_collect_http_params | SW_PLUGIN_FASTAPI_COLLECT_HTTP_PARAMS | <class 'bool'> | False | This config item controls that whether the FastAPI plugin should collect the parameters of the request. |
 | plugin_bottle_collect_http_params | SW_PLUGIN_BOTTLE_COLLECT_HTTP_PARAMS | <class 'bool'> | False | This config item controls that whether the Bottle plugin should collect the parameters of the request. |
 | plugin_celery_parameters_length | SW_PLUGIN_CELERY_PARAMETERS_LENGTH | <class 'int'> | 512 | The maximum length of `celery` functions parameters, longer than this will be truncated, 0 turns off |
+| plugin_grpc_ignored_methods | SW_PLUGIN_GRPC_IGNORED_METHODS | <class 'str'> |  | Comma-delimited list of user-defined grpc methods to ignore, like /package.Service/Method1,/package.Service/Method2 |
 ###  Sampling Configurations
 | Configuration | Environment Variable | Type | Default Value | Description |
 | :------------ | :------------ | :------------ | :------------ | :------------ |

docs/en/setup/Plugins.md

@@ -26,6 +26,7 @@ or a limitation of SkyWalking auto-instrumentation (welcome to contribute!)
 | [hug](https://falcon.readthedocs.io/en/stable/) | Python >=3.11 - NOT SUPPORTED YET; Python >=3.10 - ['2.5', '2.6']; Python >=3.7 - ['2.4.1', '2.5', '2.6'];  | `sw_falcon` |
 | [fastapi](https://fastapi.tiangolo.com) | Python >=3.7 - ['0.89.*', '0.88.*'];  | `sw_fastapi` |
 | [flask](https://flask.palletsprojects.com) | Python >=3.7 - ['2.0'];  | `sw_flask` |
+| [grpcio](https://grpc.io/docs/languages/python) | Python >=3.8 - ['1.*'];  | `sw_grpc` |
 | [happybase](https://happybase.readthedocs.io) | Python >=3.7 - ['1.2.0'];  | `sw_happybase` |
 | [http_server](https://docs.python.org/3/library/http.server.html) | Python >=3.7 - ['*'];  | `sw_http_server` |
 | [werkzeug](https://werkzeug.palletsprojects.com/) | Python >=3.7 - ['1.0.1', '2.0'];  | `sw_http_server` |

poetry.lock

@@ -137,6 +137,7 @@ httpx = "^0.23.3"
 confluent-kafka = "^2.0.2"
 neo4j = "^5.9.0"
 pulsar-client = "3.3.0"
+grpcio = "^1.49.1"
 
 [tool.poetry.group.lint.dependencies]
 pylint = '2.13.9'

pyproject.toml

@@ -55,6 +55,7 @@ class Component(Enum):
     AIORedis = 7017
     Websockets = 7018
     HTTPX = 7019
+    Grpc = 23
 
 
 class Layer(Enum):
@@ -89,6 +90,6 @@ def is_exit(self):
 
 class Log(object):
 
-    def __init__(self, timestamp: time = time.time(), items: List[LogItem] = None): # noqa
+    def __init__(self, timestamp: time = time.time(), items: List[LogItem] = None):  # noqa
         self.timestamp = timestamp
         self.items = items or []

skywalking/__init__.py

@@ -37,6 +37,7 @@
 
 RE_IGNORE_PATH: Pattern = re.compile('^$')
 RE_HTTP_IGNORE_METHOD: Pattern = RE_IGNORE_PATH
+RE_GRPC_IGNORED_METHODS: Pattern = RE_IGNORE_PATH
 
 options = None  # here to include 'options' in globals
 options = globals().copy()
@@ -212,6 +213,8 @@
 plugin_bottle_collect_http_params: bool = os.getenv('SW_PLUGIN_BOTTLE_COLLECT_HTTP_PARAMS', '').lower() == 'true'
 # The maximum length of `celery` functions parameters, longer than this will be truncated, 0 turns off
 plugin_celery_parameters_length: int = int(os.getenv('SW_PLUGIN_CELERY_PARAMETERS_LENGTH', '512'))
+# Comma-delimited list of user-defined grpc methods to ignore, like /package.Service/Method1,/package.Service/Method2
+plugin_grpc_ignored_methods: str = os.getenv('SW_PLUGIN_GRPC_IGNORED_METHODS', '').upper()
 
 # BEGIN: Sampling Configurations
 # The number of samples to take in every 3 seconds, 0 turns off
@@ -284,6 +287,7 @@ def finalize_regex() -> None:
     reesc = re.compile(r'([.*+?^=!:${}()|\[\]\\])')
     suffix = r'^.+(?:' + '|'.join(reesc.sub(r'\\\1', s.strip()) for s in agent_ignore_suffix.split(',')) + ')$'
     method = r'^' + '|'.join(s.strip() for s in plugin_http_ignore_method.split(',')) + '$'
+    grpc_method = r'^' + '|'.join(s.strip() for s in plugin_grpc_ignored_methods.split(',')) + '$'
     path = '^(?:' + \
            '|'.join(  # replaces ","
                '/(?:[^/]*/)*'.join(  # replaces "/**/"
@@ -297,15 +301,20 @@ def finalize_regex() -> None:
                ) for p0 in agent_trace_ignore_path.split(',')
            ) + ')$'
 
-    global RE_IGNORE_PATH, RE_HTTP_IGNORE_METHOD
+    global RE_IGNORE_PATH, RE_HTTP_IGNORE_METHOD, RE_GRPC_IGNORED_METHODS
     RE_IGNORE_PATH = re.compile(f'{suffix}|{path}')
     RE_HTTP_IGNORE_METHOD = re.compile(method, re.IGNORECASE)
+    RE_GRPC_IGNORED_METHODS = re.compile(grpc_method, re.IGNORECASE)
 
 
 def ignore_http_method_check(method: str):
     return RE_HTTP_IGNORE_METHOD.match(method)
 
 
+def ignore_grpc_method_check(method: str):
+    return RE_GRPC_IGNORED_METHODS.match(method)
+
+
 def finalize() -> None:
     """
     invokes finalizers

skywalking/config.py

@@ -23,4 +23,4 @@ def register(self):
         for name in dir(self):
             if name.endswith('generator'):
                 generator = getattr(self, name)()
-                Gauge.Builder('instance_pvm_' + name[:-10], generator).build()
+                Gauge.Builder(f'instance_pvm_{name[:-10]}', generator).build()