对于大多数功能,您需要使用Sentry进行身份验证。要通过CLI工具登录,您可以使用login命令来指导您完成:
$ sentry-cli login
如果您想手动验证sentry-cli,您可以转到您的用户帐户(用户图标 - > API)中的身份验证令牌设置,并生成至少包含以下范围的新令牌:
project:read
project:releases
然后,您可以导出SENTRY_AUTH_TOKEN环境变量:
export SENTRY_AUTH_TOKEN=your-auth-token
或者,只要调用sentry-cli或将其添加到.sentryclirc配置文件,就可以提供--auth-token命令行参数。
默认情况下,sentry-cli将连接到sentry.io但是对于内部部署,您还可以在其他地方登录:
sentry-cli --url https://myserver.invalid/ login
一、配置文件
可以使用名为.sentryclirc的配置文件以及环境变量和.env文件配置sentry-cli工具。从当前路径向上查找配置文件,始终加载〜/ .sentryclirc的默认值。您还可以从命令行参数覆盖这些设置。
配置文件使用标准INI语法。
默认情况下,sentry-cli将连接到sentry.io。对于本地,您可以导出SENTRY_URL环境变量并将其指向您的安装:
export SENTRY_URL=https://mysentry.invalid/
或者,您可以将其添加到〜/ .sentryclirc配置中。这也是login命令的作用:
[defaults]
url = https://mysentry.invalid/
二、配置值
可以使用以下设置(首先是环境变量,括号中的值是配置文件中的配置键):
SENTRY_AUTH_TOKEN(auth.token):
用于与Sentry进行所有通信的身份验证令牌。
SENTRY_API_KEY(auth.api_key):
用于身份验证的旧API密钥(如果有)。
SENTRY_URL(defaults.url):
用于连接到哨兵的URL。默认为https://sentry.io/。
SENTRY_ORG(defaults.org):
组织用于命令的slu ..
SENTRY_PROJECT(defaults.project):
用于命令的项目的slu ..
(http.keepalive):
此ini only设置用于控制SDK与HTTP keepalive相关的行为。默认值为true,但可以将其设置为false以禁用keepalive支持。
http_proxy(http.proxy_url):
应该用于HTTP代理的URL。标准的http_proxy环境变量也很受尊重。请注意它是小写的。
(http.proxy_username):
此ini only设置设置代理用户名,以防需要代理身份验证。
(http.proxy_password):
此ini only设置设置代理密码,以防需要代理身份验证。
(http.verify_ssl):
当设置为false时,这可用于禁用SSL验证。除非您在本地使用已知的自签名服务器,否则不应该这样做。
(http.check_ssl_revoke):
如果将其设置为false,则在Windows上禁用SSL吊销检查。在使用未正确实施吊销检查的公司SSL MITM代理时,这非常有用。除非绝对必要,否则不要使用它。
(ui.show_notifications):
如果将其设置为false,则会禁用某些操作系统通知。这当前主要影响xcode构建,不会显示后台构建的通知。
SENTRY_LOG_LEVEL(log.level):
配置SDK的日志级别。默认为警告。如果要查看库正在执行的操作,可以将其设置为info,这将显示更多可能有助于调试某些权限问题的信息。
(dsym.max_upload_size):
将调试符号的最大上载大小(以压缩形式)设置为一个批处理。默认值为35MB或100MB(取决于sentry-cli的版本),适用于sentry.io,但如果您使用的是其他哨兵服务器,则可能需要更改此限制。
SENTRY_DISABLE_UPDATE_CHECK(update.disable_check):
如果设置为true,则禁用sentry-cli中的自动更新检查。这是在1.17中引入的。之前的版本不包括更新检查。目前,对于基于npm的sentry-cli安装,也没有启用更新检查。
DEVICE_FAMILY(device.family):
向Sentry报告设备系列值。
DEVICE_MODEL(device.model):
设备模型值报告给Sentry。
三、验证配置
要确保一切正常,您可以运行sentry-cli信息,它应该打印出有关您连接的Sentry安装的一些基本信息以及一些身份验证信息。
四、项目配置
许多命令都要求您指定要使用的组织和项目。您可以通过多种方式指定此方法。
1、配置默认值
如果您始终使用相同的项目,则可以在.sentryclirc文件中进行设置:
[defaults]
project=my-project
org=my-org
2、环境变量
您还可以在环境变量中设置这些默认值。有两个控制它的环境变量(SENTRY_ORG和SENTRY_PROJECT)可以导出:
export SENTRY_ORG=my-org
export SENTRY_PROJECT=my-project
3、属性文件
另外,sentry-cli支持从.properties文件加载配置值(在Java环境中很常见)。您可以通过将路径导出到SENTRY_PROPERTIES环境变量中的属性文件来指示sentry-cli从那里加载配置文件。这通常是针对我们的一些客户端集成(如Java和React-Native)自动完成的。
在属性文件中,您只需使用点分表示法来设置值。例:
defaults.url=https://mysentry.invalid/
然后指示sentry-cli使用该文件使用:
export SENTRY_PROPERTIES=/path/to/sentry.properties
sentry-cli ...
4、显示选项
最后,您还可以使用正在执行的命令显式提供这些值。对于组织,参数始终称为--org或-o,对于项目,参数始终称为--project或-p。
请注意,它们并不总是使用相同的命令。例如,如果您正在管理发布(在整个组织中共享),您通常会将组织提供给releases命令,但将项目提供给子命令:
$ sentry-cli releases -o my-org new -p my-project 1.0
有关更多信息,请使用help命令,该命令将为您提供所有参数的文档。