跳转到主要内容

向Sentry报告Odoo错误

项目描述

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

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

选项

描述

默认值

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_include_context

如果启用,将提取当前HTTP请求和用户会话(如果可用)的附加上下文数据。这对于Cron作业没有影响,因为Cron作业内部没有请求/会话。

True

sentry_release

明确指定要发送的版本作为Sentry的发布版本。与Sentry的“在下一个版本中解决”功能结合使用很有用。如果您的生产部署不包括任何可能从中读取提交的Git上下文,也很有用。覆盖 sentry_odoo_dir

sentry_odoo_dir

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

可以通过在您的Odoo配置文件中将参数名称前缀为 sentry_ 来配置其他 客户端参数。目前支持的其他客户端参数包括: include_local_variables, max_breadcrumbs, release, environment, server_name, shutdown_timeout, in_app_include, in_app_exclude, default_integrations, dist, sample_rate, send_default_pii, http_proxy, https_proxy, max_request_body_size, debug, attach_stacktrace, ca_certs, propagate_traces, traces_sample_rate, auto_enabling_integrations

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_include_context = true
sentry_environment = production
sentry_release = 1.3.2
sentry_odoo_dir = /home/odoo/odoo/

目录

安装

模块可以像其他Odoo模块一样安装,只需将模块目录添加到Odoo的 addons_path 中。为了使模块能够正确地包装Odoo WSGI应用程序,它还需要作为全局服务器模块加载。这可以通过您的Odoo配置文件中的 server_wide_modules 参数或使用 --load 命令行参数来完成。

此模块还需要系统上安装sentry-sdk Python包。可以使用pip安装

pip install sentry-sdk

配置

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

用法

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

Try me on Runbot

已知问题/路线图

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

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

错误跟踪器

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

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

致谢

作者

  • Mohammed Barsi

  • Versada

  • Nicolas JEUDY

  • Vauxoo

贡献者

其他致谢

  • Vauxoo

维护者

此模块由OCA维护。

Odoo Community Association

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

当前维护者

barsi naglis versada moylop260 fernandahf

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

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

项目详情


下载文件

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

源代码分发

本发行版没有提供源代码分发文件。请参阅有关生成分发存档的教程。

构建分发

odoo12_addon_sentry-12.0.2.0.3-py3-none-any.whl (32.4 kB 查看哈希值)

上传时间 Python 3

由...