Help us learn about your current experience with the documentation. Take the survey.

Sentry 错误跟踪

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Sentry 是一个开源的错误跟踪系统。GitLab 允许管理员将 Sentry 连接到 GitLab,这样用户就可以在 GitLab 中查看 Sentry 错误列表。

GitLab 与云端托管的 Sentry 以及部署在您的 本地实例 中的 Sentry 进行集成。

为项目启用 Sentry 集成

GitLab 提供了一种将 Sentry 连接到您项目的方法。

先决条件:

  • 您必须拥有项目的 Maintainer(维护者)角色或更高权限。

要启用 Sentry 集成:

  1. 注册 Sentry.io 账户,或部署您自己的 本地 Sentry 实例
  2. 创建一个新的 Sentry 项目。 对于您想要集成的每个 GitLab 项目,请创建一个新的 Sentry 项目。
  3. 查找或生成一个 Sentry 认证令牌。 对于 Sentry 的 SaaS 版本,您可以在 https://sentry.io/api/ 查找或生成认证令牌。 为该令牌至少授予以下权限范围:project:readevent:readevent:write(用于解决事件)。
  4. 在 GitLab 中,启用并配置错误跟踪:
    1. 在左侧边栏,选择 Search or go to 并找到您的项目。
    2. 选择 Settings > Monitor,然后展开 Error Tracking
    3. 对于 Enable error tracking,选择 Active
    4. 对于 Error tracking backend,选择 Sentry
    5. 对于 Sentry API URL,输入您的 Sentry 主机名。例如, 输入 https://sentry.example.com。 对于 Sentry 的 SaaS 版本,主机名是 https://sentry.io。 对于托管在欧盟的 Sentry SaaS 版本,主机名是 https://de.sentry.io
    6. 对于 Auth Token,输入您之前生成的令牌。
    7. 要测试与 Sentry 的连接并填充 Project 下拉列表, 选择 Connect
    8. Project 列表中选择一个 Sentry 项目,将其链接到您的 GitLab 项目。
    9. 选择 Save changes

要查看 Sentry 错误列表,在您项目的侧边栏中,转到 Monitor > Error Tracking

启用 Sentry 与 GitLab 的集成

您可能还想按照 Sentry 文档 中的步骤启用 Sentry 的 GitLab 集成。

故障排除

在使用错误跟踪时,您可能会遇到以下问题。

错误 连接失败。请检查认证令牌并重试

如果在 项目设置 中禁用了 Monitor 功能, 当您尝试 为项目启用 Sentry 集成 时,您可能会看到错误。 对 /project/path/-/error_tracking/projects.json?api_host=https:%2F%2Fsentry.example.com%2F&token=<token> 的请求会返回 404 错误。

要解决此问题,请为项目启用 Monitor 功能。

错误 连接失败。请重新检查认证令牌并重试

本地 Sentry 集成在尝试连接时可能会遇到此问题。

要解决此问题:

  1. 在左侧边栏底部,选择 Admin
  2. 选择 Settings > Network
  3. 展开 Outbound requests
  4. 选中 Allow requests to the local network from webhooks and integrationsAllow requests to the local network from system hooks 复选框。
  5. 选择 Save changes