Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rollbar/pyrollbar
Error tracking and logging from Python to Rollbar
https://github.com/rollbar/pyrollbar
asgi django error-handling error-monitoring error-reporting exceptions fastapi flask logging observability pyramid python quart rollbar rq
Last synced: 4 days ago
JSON representation
Error tracking and logging from Python to Rollbar
- Host: GitHub
- URL: https://github.com/rollbar/pyrollbar
- Owner: rollbar
- License: mit
- Created: 2012-08-12T21:12:08.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T20:48:38.000Z (6 days ago)
- Last Synced: 2024-10-28T21:33:52.438Z (6 days ago)
- Topics: asgi, django, error-handling, error-monitoring, error-reporting, exceptions, fastapi, flask, logging, observability, pyramid, python, quart, rollbar, rq
- Language: Python
- Homepage: https://docs.rollbar.com/docs/python/
- Size: 1.26 MB
- Stars: 214
- Watchers: 39
- Forks: 134
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Pyrollbar
Proactively discover, predict, and resolve errors in real-time with Rollbar’s error monitoring platform. Start tracking errors today!
Python notifier for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
## Key benefits of using Pyrollbar are:
- **Frameworks:** Pyrollbar supports popular Python frameworks such as Django, Flask, FastAPI, AWS Lambda and more!
- **Automatic error grouping:** Rollbar aggregates Occurrences caused by the same error into Items that represent application issues. Learn more about reducing log noise.
- **Advanced search:** Filter items by many different properties. Learn more about search.
- **Customizable notifications:** Rollbar supports several messaging and incident management tools where your team can get notified about errors and important events by real-time alerts. Learn more about Rollbar notifications.
## Python Versions Supported
| PyRollbar Version | Python Version Compatibility | Support Level |
|-------------------|-----------------------------------------------|---------------------|
| 1.0.0 | 3.6, 3.7. 3.8, 3.9, 3.10, 3.11, 3.12 | Full |
| 0.16.3 | 2.7, 3.4, 3.5, 3.6, 3.7. 3.8, 3.9, 3.10, 3.11 | Security Fixes Only |
#### Support Level Definitions
**Full** - We will support new features of the library and test against all supported versions.
**Security Fixes Only** - We will only provide critical security fixes for the library.
## Frameworks Supported
Generally, PyRollbar can be used with any Python framework. However, we have official support for the following frameworks:
| Framework | Support Duration | Tested Versions |
|-----------|----------------------------|-----------------|
| Celery | Release +1 year | None |
| Django | Release or LTS end +1 year | 3.2, 4.2, 5.0 |
| FastAPI | Release +1 year | 0.101, 0.112 |
| Flask | Release +1 year | 1.1, 2.3, 3.0 |
| Pyramid | Release +1 year | 1.10, 2.0 |
Official support means that we ship and maintain integrations for these frameworks. It also means that we test against these frameworks as part of our CI pipeline.
Generally, we will support the last year of releases for a framework. If a framework has a defined support period (including LTS releases), we will support the release for the duration of that period plus one year.
### Community Supported
There are also a number of community-supported integrations available. For more information, see the [Python SDK docs](https://docs.rollbar.com/docs/python-community-supported-sdks).
## Setup Instructions
1. [Sign up for a Rollbar account](https://rollbar.com/signup)
2. Follow the [Quick Start](https://docs.rollbar.com/docs/python#section-quick-start) instructions in our [Python SDK docs](https://docs.rollbar.com/docs/python) to install pyrollbar and configure it for your platform.
## Usage and Reference
For complete usage instructions and configuration reference, see our [Python SDK docs](https://docs.rollbar.com/docs/python).
## Release History & Changelog
See our [Releases](https://github.com/rollbar/pyrollbar/releases) page for a list of all releases, including changes.
## Help / Support
If you run into any issues, please email us at [[email protected]](mailto:[email protected])
For bug reports, please [open an issue on GitHub](https://github.com/rollbar/pyrollbar/issues/new).
## Contributing
1. Fork it
2. Create your feature branch (```git checkout -b my-new-feature```).
3. Commit your changes (```git commit -am 'Added some feature'```)
4. Push to the branch (```git push origin my-new-feature```)
5. Create new Pull Request
Tests are in `rollbar/test`. To run the tests: `python setup.py test`