Metadata-Version: 2.1
Name: collective.sentry
Version: 0.2.5
Summary: Sentry integration with Plone 5.2/Zope 4
Author: Andreas Jung
Author-email: info@zopyx.com
License: GPL
Keywords: policy
Classifier: Framework :: Plone
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 5.2
Classifier: Framework :: Zope
Classifier: Framework :: Zope :: 4
Classifier: Topic :: Software Development :: Libraries :: Python Modules

collective.sentry
=================

Sentry integration with Zope.

Requirements
------------

* Plone 5.2, 5.1 (tested)
* Python 3.6+, 2.7 (tested)

Installation
------------

Add `collective.sentry` to your buildout and re-run buildout.

Configuration
-------------

Configure the Sentry DSN by setting the environment variable `SENTRY_DSN` inside your shell configuration or using buildout::

    [instance]
    environment-vars +=
        SENTRY_DSN https://......

Supplementary information logged in Sentry
------------------------------------------

`collective.sentry` will create automatically a Sentry tag `instance_name`
which is derived from the buildout part name of the related instance.  An
additional tag `project` can be configured (optional) if you set the
environment variable `SENTRY_PROJECT`.  This allows you introduce an additional
tag for filtering, if needed.


Set `SENTRY_ENVIRONMENT` to differentiate between environments e.g. staging vs production 
(https://docs.sentry.io/enriching-error-data/environments/)

Set `SENTRY_RELEASE` to sent release information to sentry. (https://docs.sentry.io/workflow/releases/)

Ser ´SENTRY_INTEGRATIONS` (comma seperated) for different Integrations. (https://docs.sentry.io/platforms/python/configuration/integrations/)

Optional activation
---------------------
By default, if you install `collective.sentry` along you eggs, the instance start will crash if you do not configure `SENTRY_DSN`.
But sometime, you have multiple environments where you want that the product to be loaded, without doing anything under the hood (same conf for dev & prod, but no sentry on dev).
To enable this behavior, add `SENTRY_OPTIONAL=1` to your environment variables.

Repository
----------

https://github.com/collective/collective.sentry

Licence
-------

- GPL2 - GNU Public License 2
- based on `raven.contrib.zope`: BSD


Author
------

ZOPYX/Andreas Jung, info@zopyx.com

`collective.sentry` has been developed as part of a Plone 5.2 migration project and it
sponsored by the University Gent.

Changelog
=========


0.2.5 (2022/07/26)
------------------

- Add optional environment parameter for Sentry integrations ("SENTRY_INTEGRATIONS", comma seperated list)
  [2silver]
- Ensure all exceptions which should be ignored are actually ignored before sending them.
  [thomasmassmann]


0.2.4 (2020/09/07)
------------------

- Ignore exceptions that are ignored in the root Zope error_log.
  [maurits]


0.2.3 (2020/08/05)
------------------
- Fix error handling on zope site root
  [krissik]

0.2.2 (2020/07/13)
------------------
- Add check with error_log ignored_exceptions before send exceptions to sentry
  [eikichi18]

0.2.1 (2020/07/08)
------------------
- Add SENTRY_ENVIRONMENT option.
  [fulv]

0.2.0 (2019/11/28)
------------------
- Add optional environment parameter to set max length of stacktrace ("SENTRY_MAX_LENGTH", default is 512)
  [Thokas]

0.1.7 (2019/10/21)
------------------
- Make collective.sentry configuration optional (do not load if no **SENTRY_DSN**)
  [kiorky]

0.1 (2019/08/15)
----------------

- initial release

Contributors
------------

- Andreas Jung <info@zopyx.com>
- Thomas Kastenholz <github@kronix.eu>
