Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref(python): Add a warning about uWSGI to all WSGI frameworks #9166

Merged
merged 2 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/bottle/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ It takes a couple of moments for the data to appear in [sentry.io](https://sentr

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

- The Sentry Python SDK will install the Bottle integration for all of your apps. The integration hooks into base Bottle class.

- All exceptions leading to an Internal Server Error are reported.
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/django/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ urlpatterns = [

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

### Issue Reporting

- If you use `django.contrib.auth` and you've set `send_default_pii=True` in your call to `init`, user data (such as current user id, email address, username) will be attached to error events.
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/falcon/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ It takes a couple of moments for the data to appear in [sentry.io](https://sentr

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

- The Sentry Python SDK will install the Falcon integration for all of your apps. The integration hooks into the base `falcon.API` class via monkey patching.

- All exceptions leading to an Internal Server Error are reported.
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/flask/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ It takes a couple of moments for the data to appear in [sentry.io](https://sentr

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

After initialization:

- If you use `flask-login` and set `send_default_pii=True` in your call to `init`, user data (current user id, email address, username) will be attached to the event.
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/pyramid/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ When you point your browser to [http://localhost:6543/](http://localhost:6543/)

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

- The Sentry Python SDK will install the Pyramid integration for all of your apps. The integration hooks into Pyramid itself, not any of your apps specifically.

- The SDK will report all exceptions leading to an Internal Server Error. These two kinds of exceptions are:
Expand Down
8 changes: 8 additions & 0 deletions docs/platforms/python/integrations/wsgi/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ make_server('', 8000, app).serve_forever()

## Behavior

<Alert level="warning" title="uWSGI and Sentry SDK">

If you're using uWSGI, note that it doesn't support threads by default. This might lead to unexpected behavior when using the Sentry SDK, from features not working properly to uWSGI workers crashing.

To enable threading support in uWSGI, make sure you have both `--enable-threads` and `--py-call-uwsgi-fork-hooks` on.

</Alert>

- 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` to `True`.

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.
Expand Down
Loading