关于 Sentry CLI
Sentry CLI 让开发者在命令行中管理 Sentry 错误追踪项目。通过该工具可以创建应用版本、上传源代码映射以改进堆栈跟踪的可读性,以及上传调试信息文件。
主要功能
- 01创建和管理应用版本
- 02上传源代码映射以解析压缩代码
- 03上传调试信息文件以支持本地调试
适用场景
- 01部署后上传源代码映射以改进错误报告的可读性
- 02跟踪应用版本发布并关联相关错误
- 03自动化 CI/CD 流程中的调试文件管理
安装
选择你的系统或包管理器,复制命令到终端运行。
安装完成后运行sentry-cli --version确认安装成功。
命令示例
常用命令按使用顺序排列。
详细介绍
重要
此仓库已停止积极开发,因为我们的新命令行工具即将取代它。
因此,我们不再接受此仓库的功能请求。此外,通常只有在存在具体原因阻碍用户采用新命令行工具时,我们才会修复此仓库中的错误。请在
getsentry/toolkit单体仓库中提出新问题,其中packages/cli目录包含新命令行工具。
Sentry CLI
此仓库包含 Sentry CLI,即 Sentry 官方命令行界面。
Sentry CLI 可用于执行许多任务,包括向 Sentry 上传调试符号和源映射、管理版本,以及查看 Sentry 数据(例如问题和日志)。
安装和使用
请参阅 Sentry CLI 文档页面。
兼容性
Sentry CLI 官方支持 Sentry SaaS 和 Sentry 自托管版 24.11.1 及更高版本。
自托管 Sentry
对于自托管安装,仅支持在相应自托管版本发布时 Sentry CLI 已提供的功能,因为新功能可能需要服务端支持。此外,某些功能(例如 sentry-cli build 命令)仅适用于 Sentry SaaS。
建议使用低于 24.11.1 的 Sentry 自托管版本的用户,在使用 3.0.0 及更高版本的 Sentry CLI 前升级其 Sentry 自托管安装。对于无法升级的用户,请使用下表所示的版本。
| Sentry 自托管版本 | 兼容的最新 Sentry CLI 版本 |
|---|---|
| ≥ 24.11.1 | latest |
| < 24.11.1 | 2.58.6 |
请注意,我们只能为官方支持的 Sentry 自托管版本提供支持。我们不会将修复回移到较旧的 Sentry CLI 版本,即使这些版本应当与您的自托管版本兼容。
版本管理
Sentry CLI 遵循语义化版本控制,具体遵循此版本管理政策。
编译
如果您想自行编译,至少需要安装以下依赖项:
- Rust stable 和 Cargo
- Make、CMake 和 C 编译器
使用 cargo 进行编译:
$ cargo build
此外,还有一个 Dockerfile,可构建基于 Alpine 的 Docker 镜像,并将
sentry-cli 添加到 PATH 中。要构建并使用它,请运行:
docker build -t sentry-cli .
docker run --rm -v $(pwd):/work sentry-cli --help