Muffin-Sentry — Sentry integration for the Muffin ASGI framework.
Requirements
Python >= 3.10
Muffin >= 1.0
sentry-sdk >= 1.40
Installation
Install using pip:
pip install muffin-sentryUsage
from muffin import Application
import muffin_sentry
app = Application("example", SENTRY_DSN="https://<public>@sentry.io/<project_id>")
# Initialize the plugin manually (optional if config is provided)
sentry = muffin_sentry.Plugin()
sentry.setup(app)
# Add custom processor (must be sync)
@sentry.processor
def enrich_event(event, hint, request):
if user := getattr(request, "user", None):
event["user"] = {"id": str(user.id)}
return event
# Raise unhandled exception
@app.route("/fail")
async def fail(request):
raise RuntimeError("Boom")
# Manually capture a message
@app.route("/capture")
async def capture(request):
sentry.capture_message("Manual log")
return "OK"
# Update scope manually
@app.route("/scope")
async def tag_scope(request):
sentry.scope.set_tag("section", "test")
sentry.capture_exception(Exception("With scope tag"))
return "OK"Configuration Options
You can configure the plugin in two ways:
Via Muffin application config (recommended):
app = Application(
"app",
SENTRY_DSN="https://...",
SENTRY_SDK_OPTIONS={"traces_sample_rate": 0.5},
)Or by calling `.setup()` manually:
sentry.setup(app, dsn="https://...", sdk_options={"traces_sample_rate": 0.5})Available options:
Name |
Default value |
Description |
dsn |
"" |
Sentry DSN for your project |
sdk_options |
{} |
Dict of options for sentry-sdk (e.g., traces_sample_rate) |
ignore_errors |
[ResponseError, ResponseRedirect] |
Exception classes to ignore |
Notes
You can access the current Sentry scope using plugin.scope.
Event processors must be synchronous functions.
Sentry sessions and transactions are handled automatically inside the plugin middleware.
Bug Tracker
Found a bug or have a feature request? Please open an issue at: https://github.com/klen/muffin-sentry/issues
Contributing
Development happens at: https://github.com/klen/muffin-sentry
Pull requests and suggestions are welcome!
License
Licensed under the MIT license.
Credits
Created by klen (Kirill Klenov)
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file muffin_sentry-2.0.0.tar.gz.
File metadata
- Download URL: muffin_sentry-2.0.0.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6b033dc52187c0fb091b961562cb9b800ed94dbe2b86f0fa067915f5630f688f
|
|
| MD5 |
366304729ef85f953c9a4bf214238c27
|
|
| BLAKE2b-256 |
22ee9951d77f9cb15919c42f46d716316693e69492514aa32774810bdda96f2c
|
File details
Details for the file muffin_sentry-2.0.0-py3-none-any.whl.
File metadata
- Download URL: muffin_sentry-2.0.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a319d3d2a7d57821f3cd5289e22c1a645223abf24e6791ec8eee9a97594d3c4
|
|
| MD5 |
7575cafc2d6a7b6932c773de4672550e
|
|
| BLAKE2b-256 |
cc9769f6307f3cec5e523283055b1341ce99f040082c075168d0d3a4513d017b
|
