[ADD] sentry module

[naglis]

Hello all,

as discussed in HBEE/odoo_sentry#5, we would like to contribute the Sentry error reporting integration module to OCA.

I have made the following changes in comparison to our fork:

• Added the ability to specify in Odoo config file the class names of errors, which should not be reported to Sentry. The old option (sentry_report_user_errors was removed).
• Added the ability to specify in Odoo config file the logger names, which can be ignored from reporting to Sentry (option sentry_exclude_loggers).
• Added the SanitizeOdooCookiesProcessor to sanitize sensitive cookies (session_id) in Odoo side (see also [FIX] fix security issue, as the module leak the cookies into sentry versada/odoo_sentry#6). Also added the ability to configure which processors to use in Odoo config file.
• sentry_client_dsn config key renamed to simply sentry_dsn.
• Added the ability to configure more raven client options via Odoo config file.
• Odoo WSGI application is now wrapped by the Sentry middleware in order to report errors in HTTP controllers more nicely. (AFAICT, this also requires the sentry module to be added to server_wide_modules list, otherwise, the wrapping does not work.)
• Refactored to comply with OCA guidelines.
• Added a few basic tests.

@barsi, I have included your name as one of the authors in __manifest__.py and README.rst but I was not sure if I should include it in the copyright notices in each Python file. Please let me know if you would like me to add it.

Regarding Odoo versions 8.0 and 9.0 -- I will be happy to provide backports to both of these versions if/once this is merged.

[bealdav]

Travis error are:

2017-03-06 08:32:46,628 5693 ERROR openerp_test odoo.modules.module: Module auth_signup_verify_email: 0 failures, 2 errors

2017-03-06 08:32:38,806 5693 INFO openerp_test odoo.addons.mass_editing.tests.test_mass_editing: ` Test if related actions are removed when mass editing record is unlinked.

2017-03-06 08:32:38,893 5693 WARNING openerp_test odoo.models: ir.actions.act_window.create() includes unknown fields: auto_refresh

====

I use with success v8 version of this module in production

[lasley]

❤️ it! Few minor comments, but otherwise LGTM

[lasley]

Please move these to requirements.txt

[lasley]

s/maintainer-tools/server-tools

[lasley]

10.0.1.0.0

[lasley]

odoo.exceptions.DeferredException?

[lasley]

Oh and odoo.exceptions.QWebException

Take a look at the below though - maybe we could leverage something like this to make the module a bit more future-ready?

>>> from odoo import exceptions
>>> dir(exceptions)
['AccessDenied', 'AccessError', 'DeferredException', 'MissingError', 'QWebException', 'RedirectWarning', 'UserError', 'ValidationError', 'Warning', '__builtins__', '__doc__', '__file__', '__name__', '__package__', '_logger', 'currentframe', 'except_orm', 'frame_codeinfo', 'logging']
>>> [e for e in dir(exceptions) if not e.startswith('_')]
['AccessDenied', 'AccessError', 'DeferredException', 'MissingError', 'QWebException', 'RedirectWarning', 'UserError', 'ValidationError', 'Warning', 'currentframe', 'except_orm', 'frame_codeinfo', 'logging']

[naglis]

Oh and odoo.exceptions.QWebException

Hm, QWebException does not look like a user error so maybe it would make sense to receive such errors?. Also, it's weird that QWebException is also defined in addons/base/ir/ir_qweb/qweb.py so I guess we should ignore both (if we decide to ignore).

Take a look at the below though - maybe we could leverage something like this to make the module a bit more future-ready?

Do you mean that we should analize the names in odoo.exceptions and look for Exception subclasses? IDK, the list of ignored exceptions is configurable, so one could add any new exceptions to the list in the config file. Also, analizing the exceptions at load time would feel a bit magic, i.e. you wouldn't really know which exceptions are ignored. What do you think?

[lasley]

Hmmm I didn't realize there were ignored exceptions here. Is there a reason we don't want to catch all exceptions raised by Odoo?

[lasley]

After thinking for a bit (and drinking a bit of coffee), I think actually the better question is this:

What is the definition of a "User Error" in the context of this app , and how can they be changed ?

Edit: they can be changed with sentry_ignored_exceptions in Odoo conf. My bad on that miss.

[naglis]

Odoo uses these exceptions as part of flow control and these exceptions are integrated more nicely with the client, eg. in Odoo 8, if you try to add a line to a SO before setting the partner in the SO form, you will get an except_orm informing about the partner not being set. I think getting such exceptions in Sentry would cause more noise than it would do good, so these are ignored by default (but, as you've noticed, it's configurable with sentry_ignored_exceptions).

[lasley]

Thanks for the explanation @naglis - works for me!

[lasley]

@tedsalmon please review

[paulius-sladkevicius]

@lasley @tedsalmon any possibilities to merge it soon? We've other nice module based on this that would like to push too.

[paulius-sladkevicius]

@bealdav could help and give review, would like to close this PR.

[bealdav]

👍

[lasley]

@bealdav - please use the Github review feature located in the "Files Changed" tab to indicate an official review. I assume the 👍 meant no suggestions, and an approval for merge?

[lasley]

It makes me so happy to see this merged in OCA. Thank you for the contribution @naglis

[bealdav]

Thanks a lot @naglis

[pedrobaeza]

This merging is provoking an error starting Odoo server if you don't have raven library because of this line: https://github.com/OCA/server-tools/blob/10.0/sentry/const.py#L37

[rgarnau]

Hi @naglis - I am still getting this error.

Traceback (most recent call last):
File "/usr/lib/python2.7/dist-packages/werkzeug/serving.py", line 180, in run_wsgi
execute(self.server.app)
File "/usr/lib/python2.7/dist-packages/werkzeug/serving.py", line 168, in execute
application_iter = app(environ, start_response)
File "/home/.../Odoo-buildouts/odoo/parts/odoo/odoo/service/server.py", line 250, in app
return self.app(e, s)
File "/home/.../Odoo-buildouts/odoo/parts/odoo/odoo/service/wsgi_server.py", line 184, in application
return application_unproxied(environ, start_response)
File "/home/.../Odoo-buildouts/odoo/parts/odoo/odoo/service/wsgi_server.py", line 170, in application_unproxied
result = handler(environ, start_response)
File "/home/roser/Odoo-buildouts/odoo/parts/odoo/odoo/http.py", line 1307, in call
self.load_addons()
File "/home/.../Odoo-buildouts/odoo/parts/odoo/odoo/http.py", line 1328, in load_addons
m = import('odoo.addons.' + module)
File "/home/.../Odoo-buildouts/odoo/parts/odoo/odoo/modules/module.py", line 81, in load_module
execfile(modfile, new_mod.dict)
File "/home/.../Odoo-buildouts/odoo/parts/server-tools/sentry/init.py", line 10, in
from . import const
File "/home/.../Odoo-buildouts/odoo/parts/server-tools/sentry/const.py", line 37, in
'requests_synchronous': raven.transport.RequestsHTTPTransport,
NameError: name 'raven' is not defined

[naglis]

Hi @rgarnau,

the fix is still not merged, see #883.

[rgarnau]

Thanks @naglis