eea.sentry 3.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

• Secret Scanning

• Changelog

  • 3.2 - (2026-07-13)

  • 3.1 - (2025-11-18)

  • 3.0 - (2023-05-05)

  • 2.4 - (2022-01-13)

  • 2.3 - (2021-10-11)

  • 2.2 - (2021-10-03)

  • 2.1 - (2021-09-28)

  • 2.0 - (2021-09-28)

  • 1.5 - (2021-09-24)

  • 1.4 - (2019-12-02)

  • 1.3 - (2019-11-15)

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

Secret Scanning

This repository uses the Betterleaks GitHub Action to scan the current repository content on every push and pull request. The scan uses the rules in .gitleaks.toml and uploads a betterleaks-report artifact when a finding is detected.

If the optional SMTP secrets are configured, failed scans also send an email to the last commit committer. The workflow expects these repository or organization secrets:

• SMTP_URL

• SMTP_PORT (optional, defaults to 25)

• SMTP_EMAIL

• SMTP_PASSWORD (optional if the SMTP server does not require authentication)

Port 465 is sent with direct TLS; other ports use the default SMTP handshake. The email includes a short finding summary from the redacted Betterleaks report, including the redacted matched line from each finding.

There are three common outcomes:

1. Everything is OK. The Betterleaks / Scan for secrets check is green and no action is needed. Regular references to runtime values are OK, for example:

   token_from_cookie = request.cookies.get("auth_token")

2. A real secret was found. The check is red and the workflow log asks you to download the betterleaks-report artifact. Open the artifact from the GitHub Actions run and check the reported file, line and rule. Remove the committed value, move it to the proper secret store, and rotate it if it was exposed. A report entry looks like this:

   {
     "RuleID": "secret-literal-assignment",
     "File": "src/config.py",
     "StartLine": 12,
     "Secret": "[REDACTED]"
   }

3. The finding is a false positive. Keep the value only if it is clearly not sensitive, such as a test fixture, placeholder, or public example. Add betterleaks:allow on the same line and include a short explanation in the pull request:

   test_password = "admin"  #betterleaks:allow

Do not add betterleaks:allow to real credentials.

Changelog

3.2 - (2026-07-13)

• Change: fix: SonarQube report - refs #305404 [avoinea]

3.1 - (2025-11-18)

• Change: Replace Python linting to ruff [mihaidobrescu1111 = refs #286821]

• Change: Add plone6 tests [mihaidobrescu1111 = refs #293593]

3.0 - (2023-05-05)

• Refactor: Drop eea.cache dependency in favor of plone.memoize [avoinea]

2.4 - (2022-01-13)

• Bug fix: AttributeError PARENTS [avoinea]

2.3 - (2021-10-11)

• Bug fix: KeyError HTTP_USER_AGENT [avoinea]

• Bug fix: FilesystemResourceDirectory object has no attribute getId [avoinea]

2.2 - (2021-10-03)

• Fix python version in setup.py [avoinea]

2.1 - (2021-09-28)

• add upgrade step for the new javascript [valipod]

2.0 - (2021-09-28)

• Change: major version bump for the new sentry SDK

1.5 - (2021-09-24)

• Change: Migrate to the new sentry SDK [valipod]

1.4 - (2019-12-02)

• Bug fix: Fix JS integration [avoinea refs #110157]

1.3 - (2019-11-15)

• Feature: Python3 support [alecghica, iulianpetcheshi, avoinea refs #110155]

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]