|
| 1 | +# |
| 2 | +# Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | +# contributor license agreements. See the NOTICE file distributed with |
| 4 | +# this work for additional information regarding copyright ownership. |
| 5 | +# The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | +# (the "License"); you may not use this file except in compliance with |
| 7 | +# the License. You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, software |
| 12 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +# See the License for the specific language governing permissions and |
| 15 | +# limitations under the License. |
| 16 | +# |
| 17 | + |
| 18 | +import logging |
| 19 | + |
| 20 | +from skywalking import Layer, Component, config |
| 21 | +from skywalking.trace.carrier import Carrier |
| 22 | +from skywalking.trace.context import get_context, NoopContext |
| 23 | +from skywalking.trace.span import NoopSpan |
| 24 | +from skywalking.trace.tags import TagHttpMethod, TagHttpURL, TagHttpStatusCode, TagHttpParams |
| 25 | + |
| 26 | +logger = logging.getLogger(__name__) |
| 27 | + |
| 28 | +link_vector = ['https://sanic.readthedocs.io/en/latest'] |
| 29 | +support_matrix = { |
| 30 | + 'sanic': { |
| 31 | + '>=3.10': ['23.12', '24.12'], |
| 32 | + } |
| 33 | +} |
| 34 | +note = """Sanic 21.9+ plugin using signal listeners. |
| 35 | +For legacy Sanic <=21.3, see sw_sanic. |
| 36 | +Note: Sanic's touchup system recompiles handle_request at startup, |
| 37 | +so we use signal listeners instead of monkey-patching handle_request.""" |
| 38 | + |
| 39 | + |
| 40 | +def install(): |
| 41 | + from sanic import Sanic |
| 42 | + |
| 43 | + # Guard: if handle_request still has write_callback param, this is old Sanic — let sw_sanic handle it |
| 44 | + import inspect |
| 45 | + sig = inspect.signature(Sanic.handle_request) |
| 46 | + if 'write_callback' in sig.parameters: |
| 47 | + return # old Sanic, skip |
| 48 | + |
| 49 | + _original_init = Sanic.__init__ |
| 50 | + |
| 51 | + def _sw_init(self, *args, **kwargs): |
| 52 | + _original_init(self, *args, **kwargs) |
| 53 | + _register_listeners(self) |
| 54 | + |
| 55 | + Sanic.__init__ = _sw_init |
| 56 | + |
| 57 | + |
| 58 | +def _register_listeners(app): |
| 59 | + |
| 60 | + def params_tostring(params): |
| 61 | + return '\n'.join([f"{k}=[{','.join(params.getlist(k))}]" for k, _ in params.items()]) |
| 62 | + |
| 63 | + @app.on_request |
| 64 | + async def sw_on_request(request): |
| 65 | + carrier = Carrier() |
| 66 | + method = request.method |
| 67 | + |
| 68 | + for item in carrier: |
| 69 | + if item.key.capitalize() in request.headers: |
| 70 | + item.val = request.headers[item.key.capitalize()] |
| 71 | + |
| 72 | + span = NoopSpan(NoopContext()) if config.ignore_http_method_check(method) \ |
| 73 | + else get_context().new_entry_span(op=request.path, carrier=carrier) |
| 74 | + |
| 75 | + span.start() |
| 76 | + span.layer = Layer.Http |
| 77 | + span.component = Component.Sanic |
| 78 | + span.peer = f'{request.remote_addr or request.ip}:{request.port}' |
| 79 | + span.tag(TagHttpMethod(method)) |
| 80 | + span.tag(TagHttpURL(request.url.split('?')[0])) |
| 81 | + if config.plugin_sanic_collect_http_params and request.args: |
| 82 | + span.tag(TagHttpParams( |
| 83 | + params_tostring(request.args)[0:config.plugin_http_http_params_length_threshold] |
| 84 | + )) |
| 85 | + |
| 86 | + request.ctx._sw_span = span |
| 87 | + |
| 88 | + @app.on_response |
| 89 | + async def sw_on_response(request, response): |
| 90 | + span = getattr(request.ctx, '_sw_span', None) |
| 91 | + if span is None: |
| 92 | + return |
| 93 | + |
| 94 | + if response is not None: |
| 95 | + span.tag(TagHttpStatusCode(response.status)) |
| 96 | + if response.status >= 400: |
| 97 | + span.error_occurred = True |
| 98 | + |
| 99 | + span.stop() |
0 commit comments