跳转到主要内容

向Sentry报告Odoo错误

项目描述

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

此模块允许轻松地将Sentry集成到Odoo中。

目录

配置

以下附加配置选项可以添加到您的Odoo配置文件中

选项

描述

默认值

sentry_dsn

Sentry 数据源名称。您可以在Sentry项目配置中找到此值。通常看起来像这样:https://<public_key>:<secret_key>@sentry.example.com/<project id> 这是使用模块的必要选项。

''

sentry_enabled

是否启用Sentry日志记录。

False

sentry_logging_level

向Sentry发送报告的最小日志级别。可能的值:notsetdebuginfowarnerrorcritical。建议将其设置为至少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请求和用户会话(如果可用)中提取额外的上下文数据。对于Cron作业没有影响,因为在Cron作业内部没有请求/会话。

True

sentry_release

显式定义要作为发布版本发送的版本。与Sentry的“在下个版本中解决”功能结合使用很有用。如果您的生产部署不包括任何Git上下文,则非常有用,其中可能包含提交。覆盖sentry_odoo_dir

sentry_odoo_dir

Odoo安装目录的绝对路径。这是可选的,并且只会用于提取Odoo Git提交,该提交将被发送到Sentry,以便区分Odoo更新。由sentry_release覆盖

可以通过在您的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_release = 1.3.2

用法

配置和安装完成后,模块将报告配置的Sentry日志级别及以上的任何日志事件,无需采取额外操作。

Try me on Runbot

已知问题/路线图

  • 无数据库分离 – 此模块通过拦截运行中的Odoo进程中的所有Odoo日志记录来工作。这意味着一旦在一个数据库中安装,它将拦截并报告该Odoo服务器上使用的所有Odoo数据库的错误。

  • 前端集成 – 在未来,添加Odoo客户端错误报告到该模块也很有用,通过集成raven-js。此外,Sentry用户反馈表单可以集成到Odoo客户端错误对话框窗口中,允许用户简要描述事情出错时他们在做什么。

错误跟踪器

错误在GitHub Issues上跟踪。如果有问题,请检查是否已报告了您的问题。如果您是第一个发现的,请通过提供详细和受欢迎的反馈来帮助我们解决这个问题。

请勿直接联系贡献者以获取支持或技术问题的帮助。

鸣谢

作者

  • Mohammed Barsi

  • Versada

  • Nicolas JEUDY

贡献者

维护者

此模块由OCA维护。

Odoo Community Association

OCA,即Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛使用。

此模块是GitHub上的OCA/server-tools项目的一部分。

欢迎您贡献力量。有关如何贡献的信息,请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源分发

此版本没有可用的源分发文件。请参阅生成分发存档的教程。

构建分发

odoo13_addon_sentry-13.0.1.1.2-py3-none-any.whl (27.7 kB 查看哈希值)

上传时间 Python 3

由以下支持