==========
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++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 <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
=========
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]
Raw data
{
"_id": null,
"home_page": "https://github.com/eea/eea.sentry",
"name": "eea.sentry",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "EEA Add-ons Plone Zope",
"author": "European Environment Agency: IDM2 A-Team",
"author_email": "eea-edw-a-team-alerts@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/19/4b/3ff39fe463ed57d0b4095c21751393bc811e90b82023f10d325c27bf78d8/eea.sentry-3.0.zip",
"platform": null,
"description": "==========\neea.sentry\n==========\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.sentry/develop\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.sentry/job/develop/display/redirect\n :alt: Develop\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.sentry/master\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.sentry/job/master/display/redirect\n :alt: Master\n\nSentry integration for Plone and Zope\n\n.. contents::\n\n\nMain features\n=============\nIt comes with plenty of configuration options and features like:\n\n1. Easy to install/uninstall via Site Setup > Add-ons;\n2. Easily setup Sentry integration via environment variables;\n3. Report Python/Javascript errors to Sentry.\n\n\nInstall\n=======\n\n* Add eea.sentry to your eggs section in your buildout and re-run buildout::\n\n [buildout]\n eggs +=\n eea.sentry\n\n zcml +=\n eea.sentry\n\n* You can download a sample buildout from:\n\n - https://github.com/eea/eea.sentry/tree/master/buildouts/zope2\n - https://github.com/eea/eea.sentry/tree/master/buildouts/plone4\n - https://github.com/eea/eea.sentry/tree/master/buildouts/plone5\n\n* Or via docker::\n\n $ docker run --rm -p 8080:8080 -e ADDONS=\"eea.sentry\" -e SENTRY_DSN=\"https://<public_key>:<secret_key>@sentry.io\" plone\n\n* Plone:\n\n * Within Site Setup > Add-ons install eea.sentry\n\n* Zope:\n\n * Add the following lines within your ZPT files / main_template::\n\n <!-- Sentry start -->\n <div tal:replace=\"structure context/@@sentry\" />\n <script type=\"text/javascript\" src=\"/++resource++sentry.min.js\"></script>\n <script type=\"text/javascript\" src=\"/++resource++sentry.js\"></script>\n <!-- Sentry end -->\n\n\nEnvironment variables\n=====================\n\nIn order to start sending error logs to sentry you'll need to provide the following environment variables to your Zope/Plone instance:\n\n* **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**)\n* **SENTRY_SITE**, **SERVER_NAME** - Add **site** tag to Sentry logs (e.g.: **SENTRY_SITE=foo.example.com**)\n* **SENTRY_RELEASE**, **EEA_KGS_VERSION** - Add **release** tag to Sentry logs (e.g.: **SENTRY_RELEASE=5.1.5-34**)\n* **SENTRY_ENVIRONMENT** - Add **environment** tag to Sentry logs. Leave empty to automatically get it from rancher-metadata (e.g.: **SENTRY_ENVIRONMENT=staging**)\n\n\nBuildout installation\n=====================\n\n- `Zope 2 <https://github.com/eea/eea.sentry/tree/master/buildouts/zope2>`_\n- `Plone 4+ <https://github.com/eea/eea.sentry/tree/master/buildouts/plone4>`_\n- `Plone 5+ <https://github.com/eea/eea.sentry/tree/master/buildouts/plone5>`_\n\n\nSource code\n===========\n\n- `Plone 4+ on github <https://github.com/eea/eea.sentry>`_\n- `Plone 5+ on github <https://github.com/eea/eea.sentry>`_\n\n\nEggs repository\n===============\n\n- https://pypi.python.org/pypi/eea.sentry\n- http://eggrepo.eea.europa.eu/simple\n\n\nPlone versions\n==============\nIt has been developed and tested for Plone 4 and 5. See buildouts section above.\n\n\nHow to contribute\n=================\nSee the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.sentry/blob/master/CONTRIBUTING.md>`_.\n\nCopyright and license\n=====================\n\neea.sentry (the Original Code) is free software; you can\nredistribute it and/or modify it under the terms of the\nGNU General Public License as published by the Free Software Foundation;\neither version 2 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\nor FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\nfor more details.\n\nYou should have received a copy of the GNU General Public License along\nwith this program; if not, write to the Free Software Foundation, Inc., 59\nTemple Place, Suite 330, Boston, MA 02111-1307 USA.\n\nThe Initial Owner of the Original Code is European Environment Agency (EEA).\nPortions created by Eau de Web are Copyright (C) 2009 by\nEuropean Environment Agency. All Rights Reserved.\n\n\nFunding\n=======\n\nEEA_ - European Environment Agency (EU)\n\n.. _EEA: https://www.eea.europa.eu/\n.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1\n\nChangelog\n=========\n\n3.0 - (2023-05-05)\n---------------------------\n* Refactor: Drop eea.cache dependency in favor of plone.memoize\n [avoinea]\n\n2.4 - (2022-01-13)\n---------------------------\n* Bug fix: AttributeError PARENTS\n [avoinea]\n\n2.3 - (2021-10-11)\n---------------------------\n* Bug fix: KeyError HTTP_USER_AGENT\n [avoinea]\n* Bug fix: FilesystemResourceDirectory object has no attribute getId\n [avoinea]\n\n2.2 - (2021-10-03)\n---------------------------\n* Fix python version in setup.py\n [avoinea]\n\n2.1 - (2021-09-28)\n---------------------------\n* add upgrade step for the new javascript\n [valipod]\n\n2.0 - (2021-09-28)\n---------------------------\n* Change: major version bump for the new sentry SDK\n\n1.5 - (2021-09-24)\n---------------------------\n* Change: Migrate to the new sentry SDK\n [valipod]\n\n1.4 - (2019-12-02)\n---------------------------\n* Bug fix: Fix JS integration\n [avoinea refs #110157]\n\n1.3 - (2019-11-15)\n--------------------------\n* Feature: Python3 support\n [alecghica, iulianpetcheshi, avoinea refs #110155]\n\n1.2 - (2019-07-30)\n--------------------------\n* maintain backwards compatibility with non-plone systems when checking\n for anonymous\n [valipod refs #102005]\n\n1.0 - (2019-06-01)\n------------------\n* Upgrade step: Within \"Plone > Site setup > Add-ons\"\n install/reinstall eea.sentry\n [avoinea refs #104872]\n* Feature: Add JS integration\n [avoinea refs #104872]\n\n0.2 - (2019-05-16)\n------------------\n* Feature: Setup Sentry logger via environment variables\n [avoinea refs #104872]\n\n0.1 - (2019-05-16)\n------------------\n* Feature: Add custom raven processors to cleanup Zope REQUEST\n [avoinea refs #104872]\n* Upgrade step: Within \"Plone > Site setup > Add-ons\" install eea.sentry\n [avoinea refs #104872]\n\n\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Zope/Plone Sentry integration",
"version": "3.0",
"project_urls": {
"Homepage": "https://github.com/eea/eea.sentry"
},
"split_keywords": [
"eea",
"add-ons",
"plone",
"zope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "194b3ff39fe463ed57d0b4095c21751393bc811e90b82023f10d325c27bf78d8",
"md5": "e01273f8671e2b8e9c8f7683d463f5fa",
"sha256": "4924da9ceba11146c3dc42ea69607084817d93cd26fa330873f6168533d4e756"
},
"downloads": -1,
"filename": "eea.sentry-3.0.zip",
"has_sig": false,
"md5_digest": "e01273f8671e2b8e9c8f7683d463f5fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 101049,
"upload_time": "2023-05-24T11:52:13",
"upload_time_iso_8601": "2023-05-24T11:52:13.038885Z",
"url": "https://files.pythonhosted.org/packages/19/4b/3ff39fe463ed57d0b4095c21751393bc811e90b82023f10d325c27bf78d8/eea.sentry-3.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-24 11:52:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eea",
"github_project": "eea.sentry",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "eea.sentry"
}
JSON
