Metadata-Version: 2.1
Name: eea.sentry
Version: 1.3
Summary: Zope/Plone Sentry integration
Home-page: https://github.com/eea/eea.sentry
Author: European Environment Agency: IDM2 A-Team
Author-email: eea-edw-a-team-alerts@googlegroups.com
License: GPL version 2
Description: ==========
        eea.sentry
        ==========
        .. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.sentry/develop
          :target: https://ci.eionet.europa.eu/job/eea/job/eea.sentry/job/develop/display/redirect
          :alt: Develop
        .. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.sentry/master
          :target: https://ci.eionet.europa.eu/job/eea/job/eea.sentry/job/master/display/redirect
          :alt: Master
        
        Sentry integration for Plone and Zope
        
        .. contents::
        
        
        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 <https://github.com/eea/eea.sentry/tree/master/buildouts/zope2>`_
        - `Plone 4+ <https://github.com/eea/eea.sentry/tree/master/buildouts/plone4>`_
        - `Plone 5+ <https://github.com/eea/eea.sentry/tree/master/buildouts/plone5>`_
        
        
        Source code
        ===========
        
        - `Plone 4+ on github <https://github.com/eea/eea.sentry>`_
        - `Plone 5+ on github <https://github.com/eea/eea.sentry>`_
        
        
        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) <https://github.com/eea/eea.sentry/blob/master/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)
        
        .. _EEA: https://www.eea.europa.eu/
        .. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1
        
        Changelog
        =========
        
        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]
        
Keywords: EEA Add-ons Plone Zope
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.1
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: ==2.7
Description-Content-Type: text/x-rst
Provides-Extra: test
Provides-Extra: zope2
