向Sentry报告Odoo错误
项目描述
Sentry
此模块允许轻松将Odoo与Sentry集成。
安装
可以通过将模块目录添加到Odoo的addons_path来安装此模块，就像安装任何其他Odoo模块一样。为了使模块能够正确包装Odoo WSGI应用程序，它还需要作为全局模块加载。这可以通过您的Odoo配置文件中的server_wide_modules参数或使用--load命令行参数来完成。
此外，此模块还需要在系统上安装raven Python包。可以使用pip进行安装
pip install raven
配置
可以将以下附加配置选项添加到您的Odoo配置文件中
选项 |
描述 |
默认值 |
|---|---|---|
sentry_dsn |
Sentry Data Source Name。您可以在Sentry项目配置中找到此值。通常它看起来像这样：https://<public_key>:<secret_key>@sentry.example.com/<project id> 这是使用此模块的唯一必需选项。 |
'' |
sentry_enabled |
是否启用Sentry日志记录。 |
False |
sentry_logging_level |
发送报告到Sentry的最小日志级别。可能的值：notset、debug、info、warn、error、critical。建议至少设置为warn，以避免因Sentry事件而使自己受到垃圾邮件的骚扰。 |
warn |
sentry_exclude_loggers |
应从Sentry中排除的逗号分隔的记录器名称。 |
werkzeug |
sentry_ignored_exceptions |
应忽略的逗号分隔的异常。您可以在末尾使用星号符号 (*)，以忽略模块的所有异常，例如：odoo.exceptions.*。 |
odoo.exceptions.AccessDenied, odoo.exceptions.AccessError, odoo.exceptions.DeferredException, odoo.exceptions.MissingError, odoo.exceptions.RedirectWarning, odoo.exceptions.UserError, odoo.exceptions.ValidationError, odoo.exceptions.Warning, odoo.exceptions.except_orm |
sentry_processors |
以逗号分隔的处理器类字符串，将在事件发送到Sentry之前应用。 |
raven.processors.SanitizePasswordsProcessor, odoo.addons.sentry.logutils.SanitizeOdooCookiesProcessor |
sentry_transport |
用于将事件发送到Sentry的传输类。可能的值：threaded：为处理消息启动异步工作进程，synchronous：同步阻塞传输；requests_threaded：使用requests库的异步传输；requests_synchronous - 使用requests库的阻塞传输。 |
threaded |
sentry_include_context |
如果启用，将从当前HTTP请求和用户会话（如果可用）中提取附加上下文数据。对于定时任务没有影响，因为在定时任务内部没有请求/会话。 |
True |
sentry_odoo_dir |
您的Odoo安装目录的绝对路径。这是可选的，仅用于提取Odoo Git提交，并将其发送到Sentry，以区分Odoo更新。 |
可以通过在Odoo配置文件中用sentry_前缀开头来配置其他客户端参数。当前支持的附加客户端参数包括：install_sys_hook, include_paths, exclude_paths, machine, auto_log_stacks, capture_locals, string_max_length, list_max_length, site, include_versions, environment。
示例Odoo配置
以下是带有Odoo Sentry选项的示例Odoo配置文件。
[options] sentry_dsn = https://<public_key>:<secret_key>@sentry.example.com/<project id> sentry_enabled = true sentry_logging_level = warn sentry_exclude_loggers = werkzeug sentry_ignore_exceptions = odoo.exceptions.AccessDenied,odoo.exceptions.AccessError,odoo.exceptions.MissingError,odoo.exceptions.RedirectWarning,odoo.exceptions.UserError,odoo.exceptions.ValidationError,odoo.exceptions.Warning,odoo.exceptions.except_orm sentry_processors = raven.processors.SanitizePasswordsProcessor,odoo.addons.sentry.logutils.SanitizeOdooCookiesProcessor sentry_transport = threaded sentry_include_context = true sentry_environment = production sentry_auto_log_stacks = false sentry_odoo_dir = /home/odoo/odoo/
用法
配置并安装后，该模块将报告配置的Sentry日志级别及以上的任何日志事件，不需要额外的操作。
已知问题/路线图
没有数据库分离 – 此模块通过截获运行中的Odoo进程中的所有Odoo日志记录来工作。这意味着一旦在一个数据库中安装，它将截获并报告该Odoo服务器上使用的所有Odoo数据库的错误。
前端集成 – 未来，将添加Odoo客户端错误报告到此模块中，通过集成raven-js。此外，Sentry用户反馈表可以集成到Odoo客户端错误对话框窗口中，允许用户简要描述错误发生时他们在做什么。
错误追踪器
错误在GitHub Issues上进行追踪。如果遇到问题，请检查那里是否已报告您的问题。如果您首先发现了它，请通过提供详细且受欢迎的反馈来帮助我们将其消除。
致谢
图像
贡献者
Mohammed Barsi <barsintod@gmail.com>
Andrius Preimantas <andrius@versada.eu>
Naglis Jonaitis <naglis@versada.eu>
维护者
此模块由OCA维护。
OCA，或Odoo社区协会，是一个非营利组织，其使命是支持Odoo功能的协作开发并促进其广泛使用。
要为此模块做出贡献，请访问https://odoo-community.org。
哈希值 for odoo10_addon_sentry-10.0.1.0.1-py2-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 3a57380ef429c6f119eb1b12801e39950ea0e6c788930751fefbb0ae49144fa1 |
|
| MD5 | 5aa4c242ec0c8fb66fa3e3a517b308dc |
|
| BLAKE2b-256 | 71ae92d681b82ea3ac65d6cf969605157b5a2f1942e889c0689392efaff16cb3 |