Learn about using Sentry with Falcon.

The Falcon integration adds support for the Falcon web framework. The integration has been confirmed to work with Falcon 1.4 and 2.0.

Install sentry-sdk from PyPI with the falcon extra:

pip install --upgrade 'sentry-sdk[falcon]'

If you have the falcon package in your dependencies, the Falcon integration will be enabled automatically when you initialize the Sentry SDK.

Configuration should happen as early as possible in your application's lifecycle.

import sentry_sdk

    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for tracing.
    # Set profiles_sample_rate to 1.0 to profile 100%
    # of sampled transactions.
    # We recommend adjusting this value in production.

import falcon

sentry_sdk.init(...)  # same as above

class HelloWorldResource:
    def on_get(self, req, resp):
        message = {
            'hello': "world",
        1 / 0  # raises an error
        resp.media = message

app = falcon.App()
app.add_route('/', HelloWorldResource())

When you point your browser to http://localhost:8000/ a transaction will be created in the Performance section of sentry.io. Additionally, an error event will be sent to sentry.io and will be connected to the transaction.

It takes a couple of moments for the data to appear in sentry.io.

  • The Sentry Python SDK will install the Falcon integration for all of your apps. The integration hooks into the base falcon.API class via monkey patching.

  • 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.

By adding FalconIntegration to your sentry_sdk.init() call explicitly, you can set options for FalconIntegration to change its behavior:

import sentry_sdk
from sentry_sdk.integrations.falcon import FalconIntegration

    # same as above
    integrations = [

You can pass the following keyword arguments to FalconIntegration():

  • transaction_style:

    class MessageResource:
        def on_get(self, req, resp, message_id):
            msg = database.get_message(message_id)
            resp.media = msg.as_json()
    app = falcon.API()
    app.add_route("/message/{message_id}", MessageResource())

    In the above code, you would set the transaction to:

    • /myurl/b48a7686-ad8c-4c94-8c3b-412ec7f25db2123 if you set transaction_style="path".
    • /myurl/{message_id} if you set transaction_style="uri_template"

    The default is "uri_template".

  • Falcon: 1.4+
  • Python: 3.6+

The versions above apply for Sentry Python SDK version 2.0+, which drops support for some legacy Python and framework versions. If you're looking to use Sentry with older Python or framework versions, consider using an SDK version from the 1.x major line of releases.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").