forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsanic.py
More file actions
431 lines (338 loc) · 15.3 KB
/
Copy pathsanic.py
File metadata and controls
431 lines (338 loc) · 15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
import sys
import warnings
import weakref
from inspect import isawaitable
from typing import TYPE_CHECKING
from urllib.parse import urlsplit
import sentry_sdk
from sentry_sdk import continue_trace
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.integrations import DidNotEnable, Integration, _check_minimum_version
from sentry_sdk.integrations._wsgi_common import RequestExtractor, _filter_headers
from sentry_sdk.integrations.logging import ignore_logger
from sentry_sdk.scope import should_send_default_pii
from sentry_sdk.traces import SegmentSource, StreamedSpan
from sentry_sdk.tracing import TransactionSource
from sentry_sdk.tracing_utils import has_span_streaming_enabled
from sentry_sdk.utils import (
CONTEXTVARS_ERROR_MESSAGE,
HAS_REAL_CONTEXTVARS,
capture_internal_exceptions,
ensure_integration_enabled,
event_from_exception,
parse_version,
reraise,
)
if TYPE_CHECKING:
from collections.abc import Container
from typing import Any, Callable, Dict, Optional, Union
from sanic.request import Request, RequestParameters
from sanic.response import BaseHTTPResponse
from sanic.router import Route
from sentry_sdk._types import Event, EventProcessor, ExcInfo, Hint
try:
from sanic import Sanic
from sanic import __version__ as SANIC_VERSION
from sanic.exceptions import SanicException
from sanic.handlers import ErrorHandler
from sanic.router import Router
except ImportError:
raise DidNotEnable("Sanic not installed")
old_error_handler_lookup = ErrorHandler.lookup
old_handle_request = Sanic.handle_request
old_router_get = Router.get
try:
# This method was introduced in Sanic v21.9
old_startup = Sanic._startup
except AttributeError:
pass
class SanicIntegration(Integration):
identifier = "sanic"
origin = f"auto.http.{identifier}"
version: "Optional[tuple[int, ...]]" = None
def __init__(
self, unsampled_statuses: "Optional[Container[int]]" = frozenset({404})
) -> None:
"""
The unsampled_statuses parameter can be used to specify for which HTTP statuses the
transactions should not be sent to Sentry. By default, transactions are sent for all
HTTP statuses, except 404. Set unsampled_statuses to None to send transactions for all
HTTP statuses, including 404.
"""
self._unsampled_statuses = unsampled_statuses or set()
@staticmethod
def setup_once() -> None:
SanicIntegration.version = parse_version(SANIC_VERSION)
_check_minimum_version(SanicIntegration, SanicIntegration.version)
if not HAS_REAL_CONTEXTVARS:
# We better have contextvars or we're going to leak state between
# requests.
raise DidNotEnable(
"The sanic integration for Sentry requires Python 3.7+ "
" or the aiocontextvars package." + CONTEXTVARS_ERROR_MESSAGE
)
if SANIC_VERSION.startswith("0.8."):
# Sanic 0.8 and older creates a logger named "root" and puts a
# stringified version of every exception in there (without exc_info),
# which our error deduplication can't detect.
#
# We explicitly check the version here because it is a very
# invasive step to ignore this logger and not necessary in newer
# versions at all.
#
# https://github.com/huge-success/sanic/issues/1332
ignore_logger("root")
if SanicIntegration.version is not None and SanicIntegration.version < (21, 9):
_setup_legacy_sanic()
return
_setup_sanic()
class SanicRequestExtractor(RequestExtractor):
def content_length(self) -> int:
if self.request.body is None:
return 0
return len(self.request.body)
def cookies(self) -> "Dict[str, str]":
return dict(self.request.cookies)
def raw_data(self) -> bytes:
return self.request.body
def form(self) -> "RequestParameters":
return self.request.form
def is_json(self) -> bool:
raise NotImplementedError()
def json(self) -> "Optional[Any]":
return self.request.json
def files(self) -> "RequestParameters":
return self.request.files
def size_of_file(self, file: "Any") -> int:
return len(file.body or ())
def _setup_sanic() -> None:
Sanic._startup = _startup
ErrorHandler.lookup = _sentry_error_handler_lookup
def _setup_legacy_sanic() -> None:
Sanic.handle_request = _legacy_handle_request
Router.get = _legacy_router_get
ErrorHandler.lookup = _sentry_error_handler_lookup
async def _startup(self: "Sanic") -> None:
# This happens about as early in the lifecycle as possible, just after the
# Request object is created. The body has not yet been consumed.
self.signal("http.lifecycle.request")(_context_enter)
# This happens after the handler is complete. In v21.9 this signal is not
# dispatched when there is an exception. Therefore we need to close out
# and call _context_exit from the custom exception handler as well.
# See https://github.com/sanic-org/sanic/issues/2297
self.signal("http.lifecycle.response")(_context_exit)
# This happens inside of request handling immediately after the route
# has been identified by the router.
self.signal("http.routing.after")(_set_transaction)
# The above signals need to be declared before this can be called.
await old_startup(self)
async def _context_enter(request: "Request") -> None:
request.ctx._sentry_do_integration = (
sentry_sdk.get_client().get_integration(SanicIntegration) is not None
)
if not request.ctx._sentry_do_integration:
return
client = sentry_sdk.get_client()
is_span_streaming_enabled = has_span_streaming_enabled(client.options)
weak_request = weakref.ref(request)
request.ctx._sentry_scope = sentry_sdk.isolation_scope()
scope = request.ctx._sentry_scope.__enter__()
scope.clear_breadcrumbs()
scope.add_event_processor(_make_request_processor(weak_request))
if is_span_streaming_enabled:
integration = client.get_integration(SanicIntegration)
if (
isinstance(integration, SanicIntegration)
and integration._unsampled_statuses
):
warnings.warn(
"The `unsampled_statuses` option of SanicIntegration has no effect when span streaming is enabled.",
stacklevel=2,
)
sentry_sdk.traces.continue_trace(dict(request.headers))
scope.set_custom_sampling_context({"sanic_request": request})
if should_send_default_pii() and request.remote_addr:
scope.set_attribute(SPANDATA.USER_IP_ADDRESS, request.remote_addr)
span = sentry_sdk.traces.start_span(
# Unless the request results in a 404 error, the name and source
# will get overwritten in _set_transaction
name=request.path,
attributes={
"sentry.op": OP.HTTP_SERVER,
"sentry.origin": SanicIntegration.origin,
"sentry.span.source": SegmentSource.URL.value,
},
parent_span=None,
)
request.ctx._sentry_root_span = span
else:
transaction = continue_trace(
dict(request.headers),
op=OP.HTTP_SERVER,
# Unless the request results in a 404 error, the name and source will get overwritten in _set_transaction
name=request.path,
source=TransactionSource.URL,
origin=SanicIntegration.origin,
)
request.ctx._sentry_root_span = sentry_sdk.start_transaction(
transaction
).__enter__()
async def _context_exit(
request: "Request", response: "Optional[BaseHTTPResponse]" = None
) -> None:
with capture_internal_exceptions():
if not request.ctx._sentry_do_integration:
return
integration = sentry_sdk.get_client().get_integration(SanicIntegration)
response_status = None if response is None else response.status
# This capture_internal_exceptions block has been intentionally nested here, so that in case an exception
# happens while trying to end the transaction, we still attempt to exit the hub.
with capture_internal_exceptions():
span = request.ctx._sentry_root_span
if isinstance(span, StreamedSpan):
with capture_internal_exceptions():
for attr, value in _get_request_attributes(request).items():
span.set_attribute(attr, value)
if response_status is not None:
span.set_attribute(SPANDATA.HTTP_STATUS_CODE, response_status)
span.status = "error" if response_status >= 400 else "ok"
span.end()
else:
span.set_http_status(response_status)
span.sampled &= (
isinstance(integration, SanicIntegration)
and response_status not in integration._unsampled_statuses
)
span.__exit__(None, None, None)
request.ctx._sentry_scope.__exit__(None, None, None)
async def _set_transaction(request: "Request", route: "Route", **_: "Any") -> None:
if request.ctx._sentry_do_integration:
with capture_internal_exceptions():
scope = sentry_sdk.get_current_scope()
route_name = route.name.replace(request.app.name, "").strip(".")
scope.set_transaction_name(route_name, source=TransactionSource.COMPONENT)
def _sentry_error_handler_lookup(
self: "Any", exception: Exception, *args: "Any", **kwargs: "Any"
) -> "Optional[object]":
_capture_exception(exception)
old_error_handler = old_error_handler_lookup(self, exception, *args, **kwargs)
if old_error_handler is None:
return None
if sentry_sdk.get_client().get_integration(SanicIntegration) is None:
return old_error_handler
async def sentry_wrapped_error_handler(
request: "Request", exception: Exception
) -> "Any":
try:
response = old_error_handler(request, exception)
if isawaitable(response):
response = await response
return response
except Exception:
# Report errors that occur in Sanic error handler. These
# exceptions will not even show up in Sanic's
# `sanic.exceptions` logger.
exc_info = sys.exc_info()
_capture_exception(exc_info)
reraise(*exc_info)
finally:
# As mentioned in previous comment in _startup, this can be removed
# after https://github.com/sanic-org/sanic/issues/2297 is resolved
if SanicIntegration.version and SanicIntegration.version == (21, 9):
await _context_exit(request)
return sentry_wrapped_error_handler
async def _legacy_handle_request(
self: "Any", request: "Request", *args: "Any", **kwargs: "Any"
) -> "Any":
if sentry_sdk.get_client().get_integration(SanicIntegration) is None:
return await old_handle_request(self, request, *args, **kwargs)
weak_request = weakref.ref(request)
with sentry_sdk.isolation_scope() as scope:
scope.clear_breadcrumbs()
scope.add_event_processor(_make_request_processor(weak_request))
response = old_handle_request(self, request, *args, **kwargs)
if isawaitable(response):
response = await response
return response
def _legacy_router_get(self: "Any", *args: "Union[Any, Request]") -> "Any":
rv = old_router_get(self, *args)
if sentry_sdk.get_client().get_integration(SanicIntegration) is not None:
with capture_internal_exceptions():
scope = sentry_sdk.get_isolation_scope()
if SanicIntegration.version and SanicIntegration.version >= (21, 3):
# Sanic versions above and including 21.3 append the app name to the
# route name, and so we need to remove it from Route name so the
# transaction name is consistent across all versions
sanic_app_name = self.ctx.app.name
sanic_route = rv[0].name
if sanic_route.startswith("%s." % sanic_app_name):
# We add a 1 to the len of the sanic_app_name because there is a dot
# that joins app name and the route name
# Format: app_name.route_name
sanic_route = sanic_route[len(sanic_app_name) + 1 :]
scope.set_transaction_name(
sanic_route, source=TransactionSource.COMPONENT
)
else:
scope.set_transaction_name(
rv[0].__name__, source=TransactionSource.COMPONENT
)
return rv
@ensure_integration_enabled(SanicIntegration)
def _capture_exception(exception: "Union[ExcInfo, BaseException]") -> None:
with capture_internal_exceptions():
event, hint = event_from_exception(
exception,
client_options=sentry_sdk.get_client().options,
mechanism={"type": "sanic", "handled": False},
)
if hint and hasattr(hint["exc_info"][0], "quiet") and hint["exc_info"][0].quiet:
return
sentry_sdk.capture_event(event, hint=hint)
def _get_request_attributes(request: "Request") -> "Dict[str, Any]":
"""
Return span attributes related to the HTTP request from a Sanic request.
"""
attributes = {} # type: Dict[str, Any]
if request.method:
attributes[SPANDATA.HTTP_REQUEST_METHOD] = request.method.upper()
headers = _filter_headers(dict(request.headers), use_annotated_value=False)
for header, value in headers.items():
attributes[f"{SPANDATA.HTTP_REQUEST_HEADER}.{header.lower()}"] = value
urlparts = urlsplit(request.url)
if should_send_default_pii():
attributes[SPANDATA.URL_FULL] = request.url
attributes["url.path"] = urlparts.path
if urlparts.query:
attributes[SPANDATA.HTTP_QUERY] = urlparts.query
if urlparts.scheme:
attributes[SPANDATA.NETWORK_PROTOCOL_NAME] = urlparts.scheme
if should_send_default_pii() and request.remote_addr:
attributes[SPANDATA.CLIENT_ADDRESS] = request.remote_addr
return attributes
def _make_request_processor(weak_request: "Callable[[], Request]") -> "EventProcessor":
def sanic_processor(event: "Event", hint: "Optional[Hint]") -> "Optional[Event]":
try:
if hint and issubclass(hint["exc_info"][0], SanicException):
return None
except KeyError:
pass
request = weak_request()
if request is None:
return event
with capture_internal_exceptions():
extractor = SanicRequestExtractor(request)
extractor.extract_into_event(event)
request_info = event["request"]
urlparts = urlsplit(request.url)
request_info["url"] = "%s://%s%s" % (
urlparts.scheme,
urlparts.netloc,
urlparts.path,
)
request_info["query_string"] = urlparts.query
request_info["method"] = request.method
request_info["env"] = {"REMOTE_ADDR": request.remote_addr}
request_info["headers"] = _filter_headers(dict(request.headers))
return event
return sanic_processor