发布版本

了解如何配置 SDK 以向 Sentry 报告您的发布版本。

一个 release 是部署到 环境 的代码版本。当您向 Sentry 提供有关发布版本的信息时,您可以:

  • 确定新发布版本引入的问题和回归
  • 预测导致问题的提交以及谁可能负责
  • 通过在提交消息中包含问题编号来解决这些问题
  • 在代码部署时接收电子邮件通知

在初始化 SDK 时包含 release。发布版本名称不能:

  • 包含换行符、制表符、正斜杠 (/) 或反斜杠 (\)
  • 是(全部为)句点 (.)、双句点 (..) 或空格 ( )
  • 超过 200 个字符

该值可以是任意的,但我们建议使用 语义化版本控制日历版本控制 或 Git 提交 SHA。

我们建议您的发布版本以项目特定的包标识符为前缀(例如 "mypackage@1.0.0")。

某些功能的行为取决于项目是否使用语义化或基于时间的版本控制(包括 "mypackage@" 前缀):

  • 回归检测
  • release:latest 过滤数据

我们自动检测项目是否使用语义化或基于时间的版本控制。

Copied
import sentry_sdk

sentry_sdk.init(
    # ...

    # By default the SDK will try to use the SENTRY_RELEASE
    # environment variable, or infer a git commit
    # SHA as release, however you may want to set
    # something more human-readable.
    release="myapp@1.0.0",
)

如何将 release 提供给您的代码由您决定。例如,您可以使用在构建过程或初始启动期间设置的环境变量。

如果您在 init() 中未设置 release,Sentry SDK 将尝试猜测它。SDK 首先会检查环境变量 SENTRY_RELEASE。如果未设置此环境变量,SDK 将检查是否存在 Git 仓库,并从最新提交中获取 Git SHA。如果这不起作用,SDK 将检查由托管提供商(如 HEROKU_SLUG_COMMITSOURCE_VERSIONCODEBUILD_RESOLVED_SOURCE_VERSIONCIRCLE_SHA1GAE_DEPLOYMENT_ID)使用的环境变量。

我们建议在使用该发布版本名称发送事件之前,先向 Sentry 报告新发布版本,因为这将解锁一些更多功能,例如识别回归和将提交与发布版本关联。了解更多内容,请参阅我们的发布版本文档。

配置 SDK 后,您可以安装一个仓库集成或手动向 Sentry 提供自己的提交元数据。阅读我们的设置发布版本文档以获取更多关于集成、关联提交和在部署发布版本时通知 Sentry 的信息。

通过观察用户采用情况、应用程序的使用情况、崩溃百分比和会话数据,监控发布版本的健康状况。发布版本健康状况将提供有关崩溃和错误对用户体验的影响的见解,并通过发布版本详细信息图表和过滤器揭示每个新问题的趋势。

为了监控发布版本健康状况,SDK 发送 会话