Sentry Integration for Muffin framework
Project description
Muffin-Sentry – Sentry Integration for Muffin framework
Requirements
python >= 3.8
Installation
Muffin-Sentry should be installed using pip:
pip install muffin-sentry
Usage
from muffin import Application
import muffin_sentry
# Create Muffin Application
app = Application('example')
# Initialize the plugin
# As alternative: jinja2 = Jinja2(app, **options)
sentry = muffin_sentry.Plugin()
sentry.setup(app, dsn="DSN_URL")
# Setup custom request processors (coroutines are not supported)
@sentry.processor
def user_scope(event, hint, request):
if request.user:
event['user'] = request.user.email
return event
# Use it inside your handlers
# The exception will be send to Sentry
@app.route('/unhandled')
async def catch_exception(request):
raise Exception('unhandled')
# Capture a message by manual
@app.route('/capture_message')
async def message(request):
sentry.capture_message('a message from app')
return 'OK'
# Capture an exception by manual
@app.route('/capture_exception')
async def exception(request):
sentry.capture_exception(Exception())
return 'OK'
# Update Sentry Scope
@app.route('/update_user')
async def user(request):
scope = sentry.current_scope.get()
scope.set_user({'id': 1, 'email': 'example@example.com'})
sentry.capture_exception(Exception())
return 'OK'Options
Name |
Default value |
Desctiption |
dsn |
"" |
Sentry DSN for your application |
sdk_options |
{} |
Additional options for Sentry SDK Client. See https://docs.sentry.io/platforms/python/configuration/options/ |
ignore_errors |
[ResponseError, ResponseRedirect] |
Exception Types to Ignore |
You are able to provide the options when you are initiliazing the plugin:
sentry.setup(app, dsn='DSN_URL')Or setup it inside Muffin.Application config using the SENTRY_ prefix:
SENTRY_DSN = 'DSN_URL'Muffin.Application configuration options are case insensitive
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-sentry/issues
Contributing
Development of Muffin-Sentry happens at: https://github.com/klen/muffin-sentry
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
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
File details
Details for the file muffin_sentry-1.5.0.tar.gz.
File metadata
- Download URL: muffin_sentry-1.5.0.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1012-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1d8467f61cdc18fe59043a2088ba42cd0d68223d8aec5fe8e0f45110f9acabb6 |
|
| MD5 | 397dab3b100572ca3577c5d20887030e |
|
| BLAKE2b-256 | 60052a6797399f845c071df8ae5a43db30244c7bceca1aa29007df0a11cf80f7 |
File details
Details for the file muffin_sentry-1.5.0-py3-none-any.whl.
File metadata
- Download URL: muffin_sentry-1.5.0-py3-none-any.whl
- Upload date:
- Size: 4.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1012-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f36bee8b0ff984555cd923ec781520c32691614cb7702dade6591cfd5337deee |
|
| MD5 | 1a5f7f221a2b9b49f8b822f898fb471b |
|
| BLAKE2b-256 | d6504558051f4f67ae6c110e109d2c7f4014ba9b9e9fab593b6da177e46cbcf1 |
