ftw.raven 1.0.0

Plone integration for raven / sentry.

Table of Contents

• Purpose

• Installation and configuration

• Release tracking

  • Version of a released distribution

  • Git SHA of checkout

• Ignored exceptions

• Report JavaScript errors

• Links

• Copyright

• Changelog

Purpose

This package extends raven, the Sentry integration with a Plone integration wich is not logger based but hooks into the Zope exception handling.

Be aware that there is already a standard logging based Zope / Plone integration for raven. You should use the standard implementation unless you want the exception hook based integration.

Installation and configuration

• Add the ftw.raven package to your dependencies.

• Configure the raven client with environment variables in buildout

Example configuration for buildout:

[instance]
eggs +=
    ftw.raven
environment-vars +=
    RAVEN_DSN https://123:[e-mail]/2

Release tracking

When an exception is reported, the release can be sent along. A release can either be the version number of a released distribution (e.g. released on pypi) or the HEAD SHA of a project checkout when the app is not released on pypi.

Version of a released distribution

For using a distribution version as release, the environment variable RAVEN_PROJECT_DIST must contain the name of the distribution, e.g.

[instance]
environment-vars +=
    RAVEN_PROJECT_DIST my.project

Git SHA of checkout

Usually the buildout root is a checkout of the project, thus we need to configured the RAVEN_BUILDOUT_ROOT so that the git repository is found:

[instance]
environment-vars +=
    RAVEN_BUILDOUT_ROOT ${buildout:directory}

Ignored exceptions

By default, not all exceptions are reported, because some exceptions such as redirects or 404s are not errors but are implemented as exceptions. Without configuration, the exceptions NotFound, Unauthorized and Redirect.

Reporting of those exceptions can be enabled by with the environment variable RAVEN_ENABLE_EXCEPTIONS:

[instance]
environment-vars +=
    RAVEN_ENABLE_EXCEPTIONS NotFound, Redirect

Report JavaScript errors

In order to be able to report JavaScript-errors, the ftw.raven Generic Setup profile must be installed, which registers a JavaScript including the raven library and the configuration.

Links

• Github: https://github.com/4teamwork/ftw.raven

• Issues: https://github.com/4teamwork/ftw.raven/issues

• Pypi: http://pypi.python.org/pypi/ftw.raven

• Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.raven

Copyright

This package is copyright by 4teamwork.

ftw.raven is licensed under GNU General Public License, version 2.

Changelog

1.0.0 (2016-01-15)

• Initial implementation [jone]