Pyramid

(New in version 0.5.0 )

The Pyramid integration adds support for the Pyramid Web Framework.

  1. Install sentry-sdk from PyPI:

     $ pip install --upgrade 'sentry-sdk==0.8.0'
    
  2. To configure the SDK, initialize it with the integration before or after your app has been created:

     import sentry_sdk
    
     from sentry_sdk.integrations.pyramid import PyramidIntegration
    
     sentry_sdk.init(
         dsn="___PUBLIC_DSN___",
         integrations=[PyramidIntegration()]
     )
    
     from pyramid.config import Configurator
    
     with Configurator() as config:
         ...
    

Behavior

  • The Sentry Python SDK will install the Pyramid integration for all of your apps. The integration hooks into Pyramid itself, not any of your apps specifically.

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

Options

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

  • transaction_style:

    config.add_route("myroute", "/myurl/{id}")
    config.add_view(myfunction, route_name="myroute")
    

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

    • /myurl/{id} if you set transaction_style="route_pattern"
    • myroute if you set transaction_style="route_name"

    The default is "route_name".

On this page