sentry 指南

安装

https://docs.sentry.io/platforms/javascript/guides/vue/

基础配置

https://docs.sentry.io/platforms/javascript/guides/vue/configuration/options/
可以直接传递给 init() 的对象

常用选项

dsn

string
收集错误的地址，如果没有设置，则读取环境变量中 SENTRY_DSN 的值。

debug

boolean
调试模式，默认值为 false，打开以后会多出一些信息上传，例如你可以看到 fullTrace,traceDetails 等信息。

release

string
版本号，默认情况下会自动设置或读取环境变量中 SENTRY_RELEASE 的值，一般需要搭配其他插件配套使用。

environment

string
设置当前环境，如果没有设置，则读取环境变量中 SENTRY_ENVIRONMENT 的值，环境名称不能包含换行符、空格或正斜杠，不能是字符串“None”，也不能超过 64 个字符。

tunnel

string
当你的 sentry 需要突破广告拦截器时，可以设置这个选项代替 dsn，详情。

sampleRate

number
配置错误事件的收集率，0.0~1.0，1.0 代表 100%，如果设置为 0.1 则随机发送 10% 的错误。

maxBreadcrumbs

number
此变量控制收集错误的导航痕迹总量，默认为 100，一般你的应用也没这么多操作记录，默认就足够使用了。

attachStacktrace

boolean
默认是关闭的，开启后可以看到详细的调用栈信息。

denyUrls

Array
使用正则来匹配不发送错误的 url 列表。

allowUrls

Array
使用正则来匹配发送错误的 url 列表。

autoSessionTracking

boolean
启用会话跟踪功能的标志，默认为 true。

initialScope

ScopeContext | Scope
设置初始数据，对象或者函数

maxValueLength

number
发送数据的单个字段长度，默认为 250。

normalizeDepth

number
限制数组或对象的深度，默认为 3，设置 0 为禁用。

normalizeMaxBreadth

number
限制数组的长度或者对象的属性。默认为 1000。

enabled

boolean
是否发送页面错误事件到 sentry，默认为 true，即使设置为 false 也不会完全禁止，如果想要去完全禁止，可以有条件的调用 Sentry.init。

sendClientReports

boolean
设置为 fase 可禁用客户端报告的发送，客户端报告目前主要用于为从未发送的事件发出结果。

集成配置(Integration Configuration)

integrations

https://docs.sentry.io/platforms/javascript/guides/vue/configuration/integrations/

Integration[]
自定义的集成工具配置，或者在配置 tree shaking 的时候会用到。

defaultIntegrations

false | Integration[]
默认集成，设置为 false 即可禁用默认配置。

钩子事件(Hooks)

beforeSend

function
在发送错误事件之前的操作，例如：忽略、修改、删除某些错误。

beforeBreadcrumb

function
产生导航痕迹事件之前，当函数未返回任何内容时，将删除痕迹导航。若要传递痕迹导航，请返回第一个参数，其中包含痕迹导航对象。回调通常获取第二个参数（称为“hint”），其中包含从中创建痕迹导航的原始对象，以进一步自定义痕迹导航的外观。

传输配置(Transport Options)

transport

function
它采用传输选项并返回用于将事件发送到 Sentry 的 Transport 对象。

追踪选项(Tracing Options)

tracesSampleRate

number
定义 transaction 的发送率

tracesSampler

function
返回值为 tracesSampleRate，可以决定哪些 transaction 可以发送或动态决定发送率，如果和 tracesSampleRate 一起被定义，则会忽略 tracesSampleRate