eea.sentry 1.2

Zope/Plone Sentry integration

Sentry integration for Plone and Zope

Contents

• Main features

• Install

• Environment variables

• Buildout installation

• Source code

• Eggs repository

• Plone versions

• How to contribute

• Copyright and license

• Funding

• Changelog

  • 1.2 - (2019-07-30)

  • 1.0 - (2019-06-01)

  • 0.2 - (2019-05-16)

  • 0.1 - (2019-05-16)

Main features

It comes with plenty of configuration options and features like:

1. Easy to install/uninstall via Site Setup > Add-ons;

2. Easily setup Sentry integration via environment variables;

3. Report Python/Javascript errors to Sentry.

Install

• Add eea.sentry to your eggs section in your buildout and re-run buildout:

  [buildout]
  eggs +=
    eea.sentry
  
  zcml +=
    eea.sentry

• You can download a sample buildout from:

  • https://github.com/eea/eea.sentry/tree/master/buildouts/zope2

  • https://github.com/eea/eea.sentry/tree/master/buildouts/plone4

  • https://github.com/eea/eea.sentry/tree/master/buildouts/plone5

• Or via docker:

  $ docker run --rm -p 8080:8080 -e ADDONS="eea.sentry" -e SENTRY_DSN="https://<public_key>:<secret_key>@sentry.io" plone

• Plone:

  • Within Site Setup > Add-ons install eea.sentry

• Zope:

  • Add the following lines within your ZPT files / main_template:

    <!-- Sentry start -->
    <div tal:replace="structure context/@@sentry" />
    <script type="text/javascript" src="/++resource++raven.min.js"></script>
    <script type="text/javascript" src="/++resource++sentry.js"></script>
    <!-- Sentry end -->

Environment variables

In order to start sending error logs to sentry you’ll need to provide the following environment variables to your Zope/Plone instance:

• SENTRY_DSN - Send python tracebacks to sentry.io or your custom Sentry installation (e.g.: SENTRY_DSN=https://<public_key>:<secret_key>@sentry.example.com)

• SENTRY_SITE, SERVER_NAME - Add site tag to Sentry logs (e.g.: SENTRY_SITE=foo.example.com)

• SENTRY_RELEASE, EEA_KGS_VERSION - Add release tag to Sentry logs (e.g.: SENTRY_RELEASE=5.1.5-34)

• SENTRY_ENVIRONMENT - Add environment tag to Sentry logs. Leave empty to automatically get it from rancher-metadata (e.g.: SENTRY_ENVIRONMENT=staging)

Buildout installation

• Zope 2

• Plone 4+

• Plone 5+

Source code

• Plone 4+ on github

• Plone 5+ on github

Eggs repository

• https://pypi.python.org/pypi/eea.sentry

• http://eggrepo.eea.europa.eu/simple

Plone versions

It has been developed and tested for Plone 4 and 5. See buildouts section above.

How to contribute

See the contribution guidelines (CONTRIBUTING.md).

Copyright and license

eea.sentry (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

The Initial Owner of the Original Code is European Environment Agency (EEA). Portions created by Eau de Web are Copyright (C) 2009 by European Environment Agency. All Rights Reserved.

Funding

EEA - European Environment Agency (EU)

Changelog

1.2 - (2019-07-30)

• maintain backwards compatibility with non-plone systems when checking for anonymous [valipod refs #102005]

1.0 - (2019-06-01)

• Upgrade step: Within “Plone > Site setup > Add-ons” install/reinstall eea.sentry [avoinea refs #104872]

• Feature: Add JS integration [avoinea refs #104872]

0.2 - (2019-05-16)

• Feature: Setup Sentry logger via environment variables [avoinea refs #104872]

0.1 - (2019-05-16)

• Feature: Add custom raven processors to cleanup Zope REQUEST [avoinea refs #104872]

• Upgrade step: Within “Plone > Site setup > Add-ons” install eea.sentry [avoinea refs #104872]