Sanic

(New in version 0.3.6)

The Sanic integration adds support for the Sanic Web Framework. We support all LTS versions of Sanic starting from 0.8. Additionally, a Python version of 3.6 or greater is required.

  1. Install sentry-sdk from PyPI:

     $ pip install --upgrade 'sentry-sdk==0.13.5'
    
  2. If you’re on Python 3.6, you also need the aiocontextvars package:

    $ pip install --upgrade aiocontextvars
    
  3. To configure the SDK, initialize it with the integration before or after your app has been initialized:

    import sentry_sdk
    from sentry_sdk.integrations.sanic import SanicIntegration
    from sanic import Sanic
        
    sentry_sdk.init(
        dsn="___PUBLIC_DSN___",
        integrations=[SanicIntegration()]
    )
    
    app = Sanic(__name__)
    

Behavior

  • The Sentry Python SDK will install the Sanic integration for all of your apps.

  • All exceptions leading to an Internal Server Error are reported.

  • Request data is attached to all events: HTTP method, URL, headers, form data, JSON payloads. Sentry excludes raw bodies and multipart file uploads. Sentry also excludes personally identifiable information (such as user ids, usernames, cookies, authorization headers, IP addresses) unless you set send_default_pii to True.

  • Logging with any logger will create breadcrumbs when the Logging integration is enabled (done by default).

On this page