Setup

Install using pip:

pip install pyramid_raven

Configure Raven DSN address in the INI configuration of your application:

raven.dsn = https://xxx:yyy@sentry.example.com/1

… or provide a SENTRY_DSN environment variable:

SENTRY_DSN=http://public:secret@example.com/1

Configure your application to include the package:

config.include('pyramid_raven')

Configure

Any raven.* namespaced settings in your .ini configuration file will be passed to the raven client constructor – although it’s your responsibility to coerce them to the right type, e.g.:

raven.timeout=3

You can augment the (already fairly comprehensive set of) request attributes sent with the logged server side exceptions by adding space seperated request property or method names (called with no args) to:

pyramid_raven.additional_request_properties=foo bar
pyramid_raven.additional_request_methods=baz bam

You can also override the panel template:

pyramid_raven.panel_tmpl=mypkg:templates/foo.tmpl

Use

You can use it to record server side errors:

@view_config(context=Exception)
def system_error_view(context, request):
    """Example catch all exception handler."""

    # Notify sentry.
    request.raven.captureException()

    # XXX E.g.: render error page.
    # ...

<!-- in production, in the head of your main layout, above all other js -->
${panel('raven-js')}

throw new Error('This javascript error will be logged.')

Tests

To run the tests, pip install nose coverage mock and e.g.:

$ nosetests --with-doctest --with-coverage --cover-tests --cover-package pyramid_raven pyramid_raven
......
Name                      Stmts   Miss  Cover   Missing
-------------------------------------------------------
pyramid_raven                 9      0   100%
pyramid_raven.client         69      0   100%
pyramid_raven.constants       5      0   100%
pyramid_raven.panel          39      0   100%
-------------------------------------------------------
TOTAL                       122      0   100%
----------------------------------------------------------------------
Ran 6 tests in 0.143s

OK