Skip to main content

Sentry Integration for Muffin framework

Project description

Muffin-SentrySentry Integration for Muffin framework

Tests Status PYPI Version

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")

# 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

Format: Name – Description (default value)

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 – Exception Types to Ignore ([muffin.ResponseRedirect, muffin.ResponseError])

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 insensetive

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

muffin-sentry-0.4.2.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

muffin_sentry-0.4.2-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file muffin-sentry-0.4.2.tar.gz.

File metadata

  • Download URL: muffin-sentry-0.4.2.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for muffin-sentry-0.4.2.tar.gz
Algorithm Hash digest
SHA256 f8ff33c5245616166933cb89375334d46b2f6db6989682bf9a1811a154b84b72
MD5 012601906baed966879f52f0423114d0
BLAKE2b-256 28b5e52804719a915bc007418fe42799ff9f73588e326ef87aedfb9726c56b4e

See more details on using hashes here.

File details

Details for the file muffin_sentry-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: muffin_sentry-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for muffin_sentry-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e5ebf8d038a5105489f23a4eb8c587a461ad739fcb15402b27f3ca99c51fa3c9
MD5 0ae078d7037c4cc2e2b5d7a4376460fa
BLAKE2b-256 d7ef5ff86513a7436a91f40dace4bad4b095b1a0e129b8bd343e80f862da4aab

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page