Report exceptions from Django to Google Stackdriver Error Reporting
Project description
dj-cloud-error: Django Google Cloud Error Reporting
Report exceptions from any Django site to Google Cloud Stackdriver Error Reporting
Free software: MIT license
Features
Report exceptions from any Django site to Google Cloud Stackdriver Error Reporting
Optional dependency on django-ipware for logging of IP addresses
Quickstart
Configure your app to user Google Cloud project:
Enabled the Error Reporting api as per https://cloud.google.com/error-reporting/docs/setup/python
Set up the required Google IAM credentials - eg set the environment variable GOOGLE_APPLICATION_CREDENTIALS as the path to a service account JSON file, for an account that has the “Errors Writer” permission.
Install the package:
pip install dj_cloud_error
Enable the provided exception handler by setting handler500 in your Django project’s root urls.py:
# in myproject/urls.py import dj_cloud_error handler500 = dj_cloud_error.handler500
Note: handler500 is only used if DEBUG = False in django settings.
Settings
To disable error reporting (eg in your CI/CD environment), add this to your django settings:
# in myproject/settings/test.py CLOUD_ERROR_REPORTING_DISABLED = True
To configure the name under which the errors appear in add this to your django settings:
CLOUD_ERROR_REPORTING_SERVICE_NAME = "myservice" # defaults to "python"
Optional Extras
If django-ipware is installed it’s used to log the client IP address, it can be installed as follows:
pip install dj_cloud_error[ip]
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.1.0 (2019-10-01)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dj_cloud_error-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8db38c9f6868f56527a6578581e55cb1f79dab33e39ccbb5663bbe7cdccacb0 |
|
MD5 | c68cd225c263724b50b19235094a221d |
|
BLAKE2b-256 | 04ce5e89e97cd7f3392f824a87d61c5346840e332f03cdd79ae0afb3d96afeed |