Sanic

(New in version 0.3.6)

The Sanic integration adds support for the Sanic Web Framework. We support the following versions:

  • 0.8
  • 18.12
  • 19.12
  • Any version of the form x.12 (LTS versions).

We do not support the latest version of Sanic. Versions between LTS releases have introduced breaking changes in the past without prior notice, so we cannot support them as they are too fast of a moving target.

A Python version of 3.6 or greater is also required.

Install

Install sentry-sdk from PyPI:

Copied
$ pip install --upgrade sentry-sdk

If you're on Python 3.6, you also need the aiocontextvars package:

Copied
$ pip install --upgrade aiocontextvars

Configure

To configure the SDK, initialize it with the integration before or after your app has been initialized:

Copied
import sentry_sdk
from sentry_sdk.integrations.sanic import SanicIntegration
from sanic import Sanic

sentry_sdk.init(
    dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
    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.

  • Each request has a separate scope. Changes to the scope within a view, for example setting a tag, will only apply to events sent as part of the request being handled.

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

You can edit this page on GitHub.