from __future__ import absolute_import from sentry_sdk.hub import Hub from sentry_sdk.tracing import SOURCE_FOR_STYLE from sentry_sdk.utils import ( capture_internal_exceptions, event_from_exception, parse_version, transaction_from_function, ) from sentry_sdk.integrations import Integration, DidNotEnable from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware from sentry_sdk.integrations._wsgi_common import RequestExtractor from sentry_sdk._types import TYPE_CHECKING if TYPE_CHECKING: from sentry_sdk.integrations.wsgi import _ScopedResponse from typing import Any from typing import Dict from typing import Callable from typing import Optional from bottle import FileUpload, FormsDict, LocalRequest # type: ignore from sentry_sdk._types import EventProcessor, Event try: from bottle import ( Bottle, Route, request as bottle_request, HTTPResponse, __version__ as BOTTLE_VERSION, ) except ImportError: raise DidNotEnable("Bottle not installed") TRANSACTION_STYLE_VALUES = ("endpoint", "url") class BottleIntegration(Integration): identifier = "bottle" transaction_style = "" def __init__(self, transaction_style="endpoint"): # type: (str) -> None if transaction_style not in TRANSACTION_STYLE_VALUES: raise ValueError( "Invalid value for transaction_style: %s (must be in %s)" % (transaction_style, TRANSACTION_STYLE_VALUES) ) self.transaction_style = transaction_style @staticmethod def setup_once(): # type: () -> None version = parse_version(BOTTLE_VERSION) if version is None: raise DidNotEnable("Unparsable Bottle version: {}".format(BOTTLE_VERSION)) if version < (0, 12): raise DidNotEnable("Bottle 0.12 or newer required.") # monkey patch method Bottle.__call__ old_app = Bottle.__call__ def sentry_patched_wsgi_app(self, environ, start_response): # type: (Any, Dict[str, str], Callable[..., Any]) -> _ScopedResponse hub = Hub.current integration = hub.get_integration(BottleIntegration) if integration is None: return old_app(self, environ, start_response) return SentryWsgiMiddleware(lambda *a, **kw: old_app(self, *a, **kw))( environ, start_response ) Bottle.__call__ = sentry_patched_wsgi_app # monkey patch method Bottle._handle old_handle = Bottle._handle def _patched_handle(self, environ): # type: (Bottle, Dict[str, Any]) -> Any hub = Hub.current integration = hub.get_integration(BottleIntegration) if integration is None: return old_handle(self, environ) # create new scope scope_manager = hub.push_scope() with scope_manager: app = self with hub.configure_scope() as scope: scope._name = "bottle" scope.add_event_processor( _make_request_event_processor(app, bottle_request, integration) ) res = old_handle(self, environ) # scope cleanup return res Bottle._handle = _patched_handle # monkey patch method Route._make_callback old_make_callback = Route._make_callback def patched_make_callback(self, *args, **kwargs): # type: (Route, *object, **object) -> Any hub = Hub.current integration = hub.get_integration(BottleIntegration) prepared_callback = old_make_callback(self, *args, **kwargs) if integration is None: return prepared_callback # If an integration is there, a client has to be there. client = hub.client # type: Any def wrapped_callback(*args, **kwargs): # type: (*object, **object) -> Any try: res = prepared_callback(*args, **kwargs) except HTTPResponse: raise except Exception as exception: event, hint = event_from_exception( exception, client_options=client.options, mechanism={"type": "bottle", "handled": False}, ) hub.capture_event(event, hint=hint) raise exception return res return wrapped_callback Route._make_callback = patched_make_callback class BottleRequestExtractor(RequestExtractor): def env(self): # type: () -> Dict[str, str] return self.request.environ def cookies(self): # type: () -> Dict[str, str] return self.request.cookies def raw_data(self): # type: () -> bytes return self.request.body.read() def form(self): # type: () -> FormsDict if self.is_json(): return None return self.request.forms.decode() def files(self): # type: () -> Optional[Dict[str, str]] if self.is_json(): return None return self.request.files def size_of_file(self, file): # type: (FileUpload) -> int return file.content_length def _set_transaction_name_and_source(event, transaction_style, request): # type: (Event, str, Any) -> None name = "" if transaction_style == "url": name = request.route.rule or "" elif transaction_style == "endpoint": name = ( request.route.name or transaction_from_function(request.route.callback) or "" ) event["transaction"] = name event["transaction_info"] = {"source": SOURCE_FOR_STYLE[transaction_style]} def _make_request_event_processor(app, request, integration): # type: (Bottle, LocalRequest, BottleIntegration) -> EventProcessor def event_processor(event, hint): # type: (Dict[str, Any], Dict[str, Any]) -> Dict[str, Any] _set_transaction_name_and_source(event, integration.transaction_style, request) with capture_internal_exceptions(): BottleRequestExtractor(request).extract_into_event(event) return event return event_processor