WSGI
If you use a WSGI framework not directly supported by the SDK, or wrote a raw WSGI app, you can use this generic WSGI middleware. It captures errors and attaches a basic amount of information for incoming requests.
Install
Copied
pip install --upgrade 'sentry-sdk'
Configure
Copied
import sentry_sdk
from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware
from my_wsgi_app import app
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
enable_tracing=True,
)
app = SentryWsgiMiddleware(app)
Verify
This minimal WSGI application will create a transaction and send it to Sentry. The error will also be sent to Sentry and associated with the transaction:
Copied
import sentry_sdk
from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware
sentry_sdk.init(...) # same as above
def app(env, start_response):
start_response('200 OK', [('Content-Type', 'text/plain')])
response_body = 'Hello World'
1/0 # this raises an error
return [response_body.encode()]
app = SentryWsgiMiddleware(app)
# Run the application in a mini WSGI server.
from wsgiref.simple_server import make_server
make_server('', 8000, app).serve_forever()
Behavior
- Request data is attached to all events: HTTP method, URL, headers. Sentry excludes raw bodies and multipart file uploads. Sentry also excludes personally identifiable information (such as user ids, usernames, cookies, authorization headers, IP addresses) unless you set
send_default_pii
toTrue
.
Each request has a separate scope. Changes to the scope within a view, for example setting a tag, will only apply to events sent as part of the request being handled.
- The WSGI middleware does not behave like a regular integration. It is not initialized through an extra parameter to
init
and is not attached to a client. When capturing or supplementing events, it just uses the currently active hub.
Supported Versions
- Python: 2.7+
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- pypi:sentry-sdk
- Version:
- 1.38.0
- Repository:
- https://github.com/getsentry/sentry-python
- API Documentation:
- https://getsentry.github.io/sentry-python/