Dj_sentry
This Django application intialize Sentry SDK to your Django application.
How to install
You can install this packaging by using:
pip install dj_sentry
Alternatively, if you use a package manager, for example Poetry, you can use:
poetry add dj_sentry
How to configure
In your settingsfiles, add the following settings to configure the Sentry SDK according with your needs:
| Setting | Type | Description |
|---|---|---|
SENTRY_DSN |
str mandatory |
Sentry project DSN. |
SENTRY_ENVIRONMENT |
str mandatory |
Environment where the application is running (for example: production, pre-production, staging) |
SENTRY_APP_PACKAGE_NAME |
str optional |
Package name of your application¹. |
SENTRY_EXTRA_INTEGRATIONS |
list optional |
List of Sentry integrations you want to use (in addition of the Django integration already set-up) |
SENTRY_EXTRA_OPTS |
dict optional |
Dict with additionnal settings for configuring the Sentry client. See Sentry client configuration |
¹: We use pkg_resources from Setuptools to get the package version of your application and send it on every events. This setting is optional but highly recommended.
By default, the setting traces_sample_rate send_default_pii have the following default values
| Setting | Value |
|---|---|
traces_sample_rate |
0 (no tracing samples sent to Sentry) |
send_default_pii |
True (send user information in events) |
You can change de values of those settings by using the SENTRY_EXTRA_OPTS setting. For example, to disable the setting that send user informations:
SENTRY_EXTRA_OPTS = {
"send_default_pii": False, # Do not send user information in Sentry events
}
Here's an example of valid configuration:
from sentry_sdk.integrations.redis import RedisIntegration from company_cms.utils.sentry import before_send_filter # Your Django configuration ... SENTRY_DSN = "https://@sentry.company.com/ SENTRY_ENVIRONMENT = "production" SENTRY_APP_PACKAGE_NAME = "company_cms" SENTRY_EXTRA_INTEGRATIONS = [RedisIntegration()] # Add Redis integration to Sentry SDK SENTRY_EXTRA_OPTS = { "before_send": before_send_filter, # Do some events filtering before sending them (see: https://docs.sentry.io/platforms/python/configuration/filtering/) } # Your Django configuration ..."
License
This project is released under BSD-3 Clause.
68 Oct 19, 2022
18 Sep 9, 2022
1.2k Jan 1, 2023
1 Nov 8, 2021
4 Aug 24, 2022
384 Nov 23, 2022
59 Dec 21, 2022
2.7k Jan 7, 2023
909 Dec 26, 2022
1.4k Jan 5, 2023
4 Nov 18, 2021
5 Jun 27, 2022
1.1k Dec 14, 2022
167 Nov 10, 2022
1 Oct 27, 2021
21 Dec 17, 2022
205 Dec 26, 2022
78 Jan 2, 2023
11 Nov 20, 2022