Sentry-CLI 使用详解(2021 Sentry v21.8.x)

内容源于：https://docs.sentry.io/product/cli/

系列

• 1 分钟快速使用 Docker 上手最新版 Sentry-CLI - 创建版本
• 快速使用 Docker 上手 Sentry-CLI - 30 秒上手 Source Maps
• Sentry For React 完整接入详解
• Sentry For Vue 完整接入详解

脑图

公众号：黑客下午茶

安装

根据您的平台，有不同的方法可用于安装 sentry-cli。

手动下载

您可以在 GitHub release 页面上找到 release 列表。
我们提供适用于 Linux、OS X 和 Windows 的可执行文件。 这是一个单独的文件下载，在收到文件后，您可以将其重命名为 sentry-cli 或 sentry-cli.exe 以使用它。

• https://github.com/getsentry/sentry-cli/releases/

自动安装

如果你使用的是 OS X 或 Linux，你可以使用自动下载器，它会为你获取最新的发行版本并安装它：

curl -sL https://sentry.io/get-cli/ | bash

这将自动为您的操作系统下载正确版本的 sentry-cli 并安装它。如果有必要，它会提示您输入 sudo 的管理员密码。

要验证它是否正确安装，您可以调出帮助：

sentry-cli --help

通过 NPM 安装

对于特殊用例，还可以选择通过 npm 安装 sentry-cli。例如，这对于构建服务器很有用。该包名为 @sentry/cli，在安装后它将下载适当的发行版二进制文件：

npm install @sentry/cli

然后您可以在 .bin 文件夹中找到它：

./node_modules/.bin/sentry-cli --help

如果您想使用 sudo 在 npm 系统范围内安装它，您需要将 --unsafe-perm 传递给它：

sudo npm install -g @sentry/cli --unsafe-perm

但是，不建议进行此安装。

从自定义源下载

默认情况下，这个包会从 Fastly 管理的 CDN 下载 sentry-cli。要使用自定义 CDN，请设置 npm config 属性 sentrycli_cdnurl。下载器将附加 "/<version>/sentry-cli-<dist>"。

• https://www.fastly.com/

npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path

或者将属性添加到您的 .npmrc 文件中 (https://docs.npmjs.com/files/npmrc)

sentrycli_cdnurl=https://mymirror.local/path

另一种选择是使用环境变量 SENTRYCLI_CDNURL。

SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli

通过 Homebrew 安装

如果您使用的是 OS X，则可以通过 homebrew 安装 sentry-cli：

brew install getsentry/tools/sentry-cli

通过 Scoop 安装

如果您使用的是 Windows，您可以通过 Scoop 安装 sentry-cli：

• https://scoop.sh/

> scoop install sentry-cli

Docker 镜像

对于不受支持的发行版和 CI 系统，我们提供了一个预装了 sentry-cli 的 Docker 镜像。建议使用 latest tag，但您也可以固定到特定版本。默认情况下，该命令在 /work 目录中运行。 挂载相关的项目文件夹并在那里构建输出以允许 sentry-cli 扫描资源：

docker pull getsentry/sentry-cli
docker run --rm -v $(pwd):/work getsentry/sentry-cli --help

更新和卸载

您可以使用 sentry-cli update 和 sentry-cli uninstall 更新或卸载 sentry CLI。 这些命令在某些情况下可能不可用(例如，如果您使用 homebrew 安装 sentry-cli)。

配置和认证

对于大多数功能，您需要使用 Sentry 进行身份验证。设置可以使用 sentry-cli 自动完成，也可以手动完成。无论哪种方式，您都需要一个至少具有以下作用域(scope)的令牌：

• project:read
• project:releases
• org:read

使用自动选项

sentry-cli login

这将为您提供访问身份验证令牌用户(auth token user)设置的选项，您可以在其中创建新的 auth token，或简单地复制现有 token。当您返回 CLI 时，您将粘贴您的 token，它会自动添加到 ~/.sentryclirc 中。

默认情况下，sentry-cli 将连接到 sentry.io，但对于自托管，您也可以在其他地方登录：

sentry-cli --url https://myserver.invalid/ login

手动验证

访问您的身份验证令牌用户(auth token user)设置页面并创建或复制现有 token。然后：

• 添加它到 ~/.sentryclirc：

[auth]
token=your-auth-token

• 将其导出为环境变量：

export SENTRY_AUTH_TOKEN=your-auth-token

• 调用 sentry-cli 时将其作为参数传递：

sentry-cli --auth-token your-auth-token

配置文件

sentry-cli 工具可以使用名为 .sentryclirc 的配置文件以及环境变量和 .env 文件进行配置。 从当前路径向上查找配置文件，并且始终加载 ~/.sentryclirc 中的默认值。 您还可以从命令行参数覆盖这些设置。

配置文件使用标准 INI 语法。

默认 sentry-cli 将连接到 sentry.io。对于本地，您可以导出 SENTRY_URL 环境变量并将其指向您的安装：

export SENTRY_URL=https://mysentry.invalid/

或者，您可以将它添加到您的 ~/.sentryclirc 配置中。这也是 login 命令的作用：

[defaults]
url = https://mysentry.invalid/

默认 sentry-cli 加载 .env 文件。在 sentry-cli 1.24 及更新版本上，您可以通过导出环境变量 SENTRY_LOAD_DOTENV=0 来禁用此功能。

配置值

可以使用以下设置(首先是环境变量，括号中的值是 config 文件中的配置 key)：

SENTRY_AUTH_TOKEN (auth.token):

• 用于与 Sentry 的所有通信的身份验证令牌(authentication token)。

SENTRY_API_KEY (auth.api_key):

• 用于身份验证的旧 API key(如果您有的话)。

SENTRY_DSN (auth.dsn):

• 用于连接 sentry 的 DSN。

SENTRY_URL (defaults.url):

• 用于连接 sentry 的 URL。默认为 https://sentry.io/。

SENTRY_OR