| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245 |
- """
- Instrumentation for Django 3.0
- Since this file contains `async def` it is conditionally imported in
- `sentry_sdk.integrations.django` (depending on the existence of
- `django.core.handlers.asgi`.
- """
- import asyncio
- import functools
- import inspect
- from django.core.handlers.wsgi import WSGIRequest
- import sentry_sdk
- from sentry_sdk.consts import OP
- from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
- from sentry_sdk.scope import should_send_default_pii
- from sentry_sdk.utils import (
- capture_internal_exceptions,
- ensure_integration_enabled,
- )
- from typing import TYPE_CHECKING
- if TYPE_CHECKING:
- from typing import Any, Callable, Union, TypeVar
- from django.core.handlers.asgi import ASGIRequest
- from django.http.response import HttpResponse
- from sentry_sdk._types import Event, EventProcessor
- _F = TypeVar("_F", bound=Callable[..., Any])
- # Python 3.12 deprecates asyncio.iscoroutinefunction() as an alias for
- # inspect.iscoroutinefunction(), whilst also removing the _is_coroutine marker.
- # The latter is replaced with the inspect.markcoroutinefunction decorator.
- # Until 3.12 is the minimum supported Python version, provide a shim.
- # This was copied from https://github.com/django/asgiref/blob/main/asgiref/sync.py
- if hasattr(inspect, "markcoroutinefunction"):
- iscoroutinefunction = inspect.iscoroutinefunction
- markcoroutinefunction = inspect.markcoroutinefunction
- else:
- iscoroutinefunction = asyncio.iscoroutinefunction # type: ignore[assignment]
- def markcoroutinefunction(func: "_F") -> "_F":
- func._is_coroutine = asyncio.coroutines._is_coroutine # type: ignore
- return func
- def _make_asgi_request_event_processor(request):
- # type: (ASGIRequest) -> EventProcessor
- def asgi_request_event_processor(event, hint):
- # type: (Event, dict[str, Any]) -> Event
- # if the request is gone we are fine not logging the data from
- # it. This might happen if the processor is pushed away to
- # another thread.
- from sentry_sdk.integrations.django import (
- DjangoRequestExtractor,
- _set_user_info,
- )
- if request is None:
- return event
- if type(request) == WSGIRequest:
- return event
- with capture_internal_exceptions():
- DjangoRequestExtractor(request).extract_into_event(event)
- if should_send_default_pii():
- with capture_internal_exceptions():
- _set_user_info(request, event)
- return event
- return asgi_request_event_processor
- def patch_django_asgi_handler_impl(cls):
- # type: (Any) -> None
- from sentry_sdk.integrations.django import DjangoIntegration
- old_app = cls.__call__
- async def sentry_patched_asgi_handler(self, scope, receive, send):
- # type: (Any, Any, Any, Any) -> Any
- integration = sentry_sdk.get_client().get_integration(DjangoIntegration)
- if integration is None:
- return await old_app(self, scope, receive, send)
- middleware = SentryAsgiMiddleware(
- old_app.__get__(self, cls),
- unsafe_context_data=True,
- span_origin=DjangoIntegration.origin,
- http_methods_to_capture=integration.http_methods_to_capture,
- )._run_asgi3
- return await middleware(scope, receive, send)
- cls.__call__ = sentry_patched_asgi_handler
- modern_django_asgi_support = hasattr(cls, "create_request")
- if modern_django_asgi_support:
- old_create_request = cls.create_request
- @ensure_integration_enabled(DjangoIntegration, old_create_request)
- def sentry_patched_create_request(self, *args, **kwargs):
- # type: (Any, *Any, **Any) -> Any
- request, error_response = old_create_request(self, *args, **kwargs)
- scope = sentry_sdk.get_isolation_scope()
- scope.add_event_processor(_make_asgi_request_event_processor(request))
- return request, error_response
- cls.create_request = sentry_patched_create_request
- def patch_get_response_async(cls, _before_get_response):
- # type: (Any, Any) -> None
- old_get_response_async = cls.get_response_async
- async def sentry_patched_get_response_async(self, request):
- # type: (Any, Any) -> Union[HttpResponse, BaseException]
- _before_get_response(request)
- return await old_get_response_async(self, request)
- cls.get_response_async = sentry_patched_get_response_async
- def patch_channels_asgi_handler_impl(cls):
- # type: (Any) -> None
- import channels # type: ignore
- from sentry_sdk.integrations.django import DjangoIntegration
- if channels.__version__ < "3.0.0":
- old_app = cls.__call__
- async def sentry_patched_asgi_handler(self, receive, send):
- # type: (Any, Any, Any) -> Any
- integration = sentry_sdk.get_client().get_integration(DjangoIntegration)
- if integration is None:
- return await old_app(self, receive, send)
- middleware = SentryAsgiMiddleware(
- lambda _scope: old_app.__get__(self, cls),
- unsafe_context_data=True,
- span_origin=DjangoIntegration.origin,
- http_methods_to_capture=integration.http_methods_to_capture,
- )
- return await middleware(self.scope)(receive, send) # type: ignore
- cls.__call__ = sentry_patched_asgi_handler
- else:
- # The ASGI handler in Channels >= 3 has the same signature as
- # the Django handler.
- patch_django_asgi_handler_impl(cls)
- def wrap_async_view(callback):
- # type: (Any) -> Any
- from sentry_sdk.integrations.django import DjangoIntegration
- @functools.wraps(callback)
- async def sentry_wrapped_callback(request, *args, **kwargs):
- # type: (Any, *Any, **Any) -> Any
- current_scope = sentry_sdk.get_current_scope()
- if current_scope.transaction is not None:
- current_scope.transaction.update_active_thread()
- sentry_scope = sentry_sdk.get_isolation_scope()
- if sentry_scope.profile is not None:
- sentry_scope.profile.update_active_thread_id()
- with sentry_sdk.start_span(
- op=OP.VIEW_RENDER,
- name=request.resolver_match.view_name,
- origin=DjangoIntegration.origin,
- ):
- return await callback(request, *args, **kwargs)
- return sentry_wrapped_callback
- def _asgi_middleware_mixin_factory(_check_middleware_span):
- # type: (Callable[..., Any]) -> Any
- """
- Mixin class factory that generates a middleware mixin for handling requests
- in async mode.
- """
- class SentryASGIMixin:
- if TYPE_CHECKING:
- _inner = None
- def __init__(self, get_response):
- # type: (Callable[..., Any]) -> None
- self.get_response = get_response
- self._acall_method = None
- self._async_check()
- def _async_check(self):
- # type: () -> None
- """
- If get_response is a coroutine function, turns us into async mode so
- a thread is not consumed during a whole request.
- Taken from django.utils.deprecation::MiddlewareMixin._async_check
- """
- if iscoroutinefunction(self.get_response):
- markcoroutinefunction(self)
- def async_route_check(self):
- # type: () -> bool
- """
- Function that checks if we are in async mode,
- and if we are forwards the handling of requests to __acall__
- """
- return iscoroutinefunction(self.get_response)
- async def __acall__(self, *args, **kwargs):
- # type: (*Any, **Any) -> Any
- f = self._acall_method
- if f is None:
- if hasattr(self._inner, "__acall__"):
- self._acall_method = f = self._inner.__acall__ # type: ignore
- else:
- self._acall_method = f = self._inner
- middleware_span = _check_middleware_span(old_method=f)
- if middleware_span is None:
- return await f(*args, **kwargs) # type: ignore
- with middleware_span:
- return await f(*args, **kwargs) # type: ignore
- return SentryASGIMixin
|