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

Sentry integration with Zope (4)/Plone (5)
https://github.com/collective/collective.sentry

monitoring plone python sentry

Last synced: 3 months ago
JSON representation

Sentry integration with Zope (4)/Plone (5)

• Host: GitHub
• URL: https://github.com/collective/collective.sentry
• Owner: collective
• Created: 2019-08-15T07:30:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T13:03:45.000Z (8 months ago)
• Last Synced: 2024-04-09T22:09:21.083Z (3 months ago)
• Topics: monitoring, plone, python, sentry
• Language: Python
• Homepage: https://pypi.org/project/collective.sentry/
• Size: 81.1 KB
• Stars: 7
• Watchers: 11
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt

Lists

• awesome-plone - collective.sentry - Sentry integration to aggregate errors and help finding their causes. (Sysadmin)

README

        
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/)

Set ´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, [email protected]

`collective.sentry` has been developed as part of a Plone 5.2 migration project and it

sponsored by the University Gent.