getsentry / getsentry/sentry-python

Docs: Integration with Django ASGI + Channels Websockets

Open
#2,556 3 comments 2 reactions 0 assignees View on GitHub
Docs Integration: Django Python
Dominant language
Python
Stars
2.2k
Forks
669
Avg merge
1d 1h
Merged PRs (30d)
213

Description

### Problem Statement

This Python SDK has support for django ASGI.  We noted that in this integration therer is a check for django channels and depending on that setup the SDK.

Currently, we use besides the django channels HTTP requests also the websockets. 
We did set it up as described here: [channels routing docs](https://channels.readthedocs.io/en/latest/topics/routing.html#routing) 

However, we noted that the sentry SDK is capturing the logs of the django_asgi_app and not the websocket requests.

Therefore, we currently circumvented this problem by wrapping the websockets inside the SentryASGIMiddleware.
```python
application = ProtocolTypeRouter(
{
"http": get_asgi_application(),
"websocket": SentryAsgiMiddleware(
URLRouter(routing.websocket_urlpatterns)
),
}
)
```

This should probably documented in the documentation of sentry to include these detail that it is only capturing of the http requests of django channels.

Futhermore, are were curious if this is the way to go or that a better integration is available. In our dashboard, we see now everything logged as generic asgi request for websocket connection instead of the usual transaction name and doubting if the SQL performance issues are logged as well.

### Solution Brainstorm

Update the docs to highlight the limitation of the current django integration in combination with django channels websockets.

Any suggestions how to provide more information in the integration SentryASGIMiddleware is welcome as well

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.