muffin-sentry 2.0.2

Sentry Integration for Muffin framework

Muffin-Sentry

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-sentry

Usage

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:

1. Via Muffin application config (recommended):

app = Application(
    "app",
    SENTRY_DSN="https://...",
    SENTRY_SDK_OPTIONS={"traces_sample_rate": 0.5},
)

2. 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)