Skip to main content

A Pyramid plugin for integrating Sentry error reporting

Project description

Hypothesis Pyramid Sentry Extension

At the moment the library is mostly being used as an experimental testing ground and therefore is not recommended for general use.

This is a Pyramid extension that wraps sentry-sdk's Pyramid integration and adds some additional customization and features.


  • Initializes sentry-sdk with its Pyramid integration for you. Your app just has to set any "h_pyramid_sentry.*" settings that you want and then do config.include("h_pyramid_sentry") (see instructions below for details).

  • Prevents retryable exceptions from being reported to Sentry if your app is using pyramid_retry and the request is going to be retried (requires the "h_pyramid_sentry.retry_support": True setting, see below).

    Retryable exceptions will still be reported to Sentry if the request is not going to be retried again because it has run out of retry attempts or because one of the retries fails with a non-retryable exception. When this happens only the exception from the request's final attempt is reported to Sentry, so you get a single Sentry event per request not multiple, but information about the previous failed attempts' exceptions is added to the single Sentry event.

  • Ignores errors logged by exc_logger if your app is using pyramid_exclog.

    pyramid_exclog logs all exceptions with log-level ERROR, and these all get picked up by sentry_sdk's enabled-by-default logging integration. This would mean that all exceptions in Sentry appear to come from exc_logger, and that some handled exceptions that wouldn't normally be reported to Sentry now would get reported. This extension prevents the interference by telling sentry_sdk to ignore exc_logger.

  • Provides a convenient method for apps to register their own filters for exceptions and logged errors that they don't want to be reported to Sentry. See the "h_pyramid_sentry.filters" setting below.


config.add_settings({...})  # See below for available settings.


In your Pyramid configuration you can provide a list of filter functions in the setting h_pyramid_sentry.filters.

These functions are passed Event objects which they can inspect. If the function returns True, then the event is not sent to Sentry.

For example to prevent reporting of ValueErrors:

    "h_pyramid_sentry.filters": [
        lambda event: instanceof(event.exception, ValueError)


The extension will listen to the following Pyramid deployment settings:

Pyramid setting Effect
h_pyramid_sentry.init A dict of any options understood by sentry_sdk.init()
h_pyramid_sentry.filters A list of functions to apply as filters
h_pyramid_sentry.retry_support * Enable retry detection and filtering
h_pyramid_sentry.celery_support * Enable Celery support for Sentry

* Enabling retry or celery support requires your application to list the relevant dependency (pyramid_retry or celery) as a dependency.

As per the Sentry docs, the environment variable SENTRY_DSN will be automatically read if set, although this can also be passed along with any other Sentry SDK options via h_pyramid_sentry.init.


Installing h-pyramid-sentry in a development environment

You will need

  • Git

  • pyenv Follow the instructions in the pyenv README to install it. The Homebrew method works best on macOS. On Ubuntu follow the Basic GitHub Checkout method.

Clone the git repo

git clone

This will download the code into a h-pyramid-sentry directory in your current working directory. You need to be in the h-pyramid-sentry directory for the rest of the installation process:

cd h-pyramid-sentry

Run the tests

make test

That's it! You’ve finished setting up your h-pyramid-sentry development environment. Run make help to see all the commands that're available for linting, code formatting, packaging, etc.

Updating the Cookiecutter scaffolding

This project was created from the template. If h-cookiecutter-pypackage itself has changed since this project was created, and you want to update this project with the latest changes, you can "replay" the cookiecutter over this project. Run:

make template

This will change the files in your working tree, applying the latest updates from the h-cookiecutter-pypackage template. Inspect and test the changes, do any fixups that are needed, and then commit them to git and send a pull request.

If you want make template to skip certain files, never changing them, add these files to "options.disable_replay" in .cookiecutter.json and commit that to git.

If you want make template to update a file that's listed in disable_replay simply delete that file and then run make template, it'll recreate the file for you.

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

h_pyramid_sentry-1.1.20191029.174836.tar.gz (9.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page