Sentry入门—通用配置

  • Post author:
  • Post category:其他


SDK可以通过多种方式进行配置。 这些选项在SDK之间基本上是标准化的,但是存在一些差异以更好地适应平台特性。 首次初始化SDK时会设置选项。

下述的选项是可以作为对象属性传递到对象初始化接口中(以JavaScript为例):

Sentry.init({
  dsn: 'https://<key>@sentry.io/<project>',
  maxBreadcrumbs: 50,
  debug: true,
})

SDK中的常用选项列表。 这些在所有SDK中的工作方式大致相同,但存在一些细微差别以更好地支持平台,常见选项有:



dsn

DSN告诉SDK将事件发送到的位置。 此选项始终是必需的,不同的SDK可能会从环境变量(SENTRY_DSN)中选择此选项,或者如果您使用的是CDN版本或浏览器SDK,则已经为您配置了该选项。



debug

打开或关闭调试模式。 如果启用了调试,如果发送事件出现问题,SDK将尝试打印出有用的调试信息。 默认值始终为false,通常不建议在生产中将其打开,但这样做不会引起任何安全问题。



release

设置发布。 有些SDK会尝试自动配置一个开箱即用的版本,但如果你有机会手动设置它是个更好的主意。 这样,它可以保证与您的部署集成或源图上传保持同步。 版本名称只是字符串,但Sentry会检测某些格式,并且可能会以不同方式呈现。 有关更多信息,请查看发行版文档。



environment

设置环境。 此字符串是自由形式,默认情况下不设置。 版本可以与多个环境相关联,以便在UI中将它们分开(想想staging vs prod或类似)。



simpleRate

将采样率配置为要在0.0到1.0范围内发送的事件的百分比。 默认值为1.0,表示发送了100%的事件。 如果设置为0.1,则仅发送10%的事件。 事件随机挑选。



maxBreadcrumbs

此变量控制应捕获的面包屑总量。 默认为100。



attachStacktrace

启用后,堆栈跟踪会自动附加到记录的所有消息。 请注意,堆栈跟踪始终附加到异常,但是当设置此项时,堆栈跟踪也会与消息一起发送。 例如,这意味着堆栈跟踪出现在所有日志消息旁边。

值得注意的是,对于具有堆栈跟踪和没有堆栈跟踪的事件,Sentry中的分组是不同的。 这意味着在为某些事件启用或禁用此标志时,您将获得新组。

默认情况下此功能处于关闭状态

sendDefaultPii

如果启用此标志,则通过活动集成添加某些个人身份信息。 没有这个标志,它们永远不会被添加到事件中。 如果可能,建议打开此功能并使用服务器端PII剥离来删除值。

serverName

可用于提供“服务器名称”。 提供时,服务器的名称将一起发送并保留在事件中。 请注意,对于许多集成,即使在计算机实际上不是服务器的情况下,服务器名称实际上也对应于设备主机名。 大多数SDK会尝试自动发现此值。

blacklistUrls

不适用于JavaScript。

不应发送给Sentry的错误URL的模式。 默认情况下,将发送所有错误。

whitelistUrls

不适用于JavaScrpt。

错误URL的模式,应该专门发送给Sentry。 默认情况下,将发送所有错误t。

requestBodies

不适用于JavaScript。

此参数控制集成是否应捕获HTTP请求正文。 它可以设置为以下值之一:

  • never:请求机构永远不会发送。
  • small:只捕获小的请求主体,其中小的截止值取决于SDK(通常为4KB)
  • medium:中型请求和小请求将被捕获。 (通常为10KB)
  • always:只要哨兵能够理解它,SDK就会始终捕获请求体

withLocals

不适用于JavaScript。

启用时,本地变量与堆栈帧一起发送。 这可能会产生性能和PII影响。 默认情况下在可用的平台上启用。