Skip to content

配置项参考

Sentry.init({ ... }) 支持的全部选项。通常只需 dsn + release 即可上手(见快速接入),下面是完整清单,按需取用。

基础

选项类型默认说明
dsnstringSentry DSN(必填,否则不上报)
releasestring版本号;Source Map 解析的关键,需与上传时的 release 完全一致
environmentstring环境标识,如 production / staging
debugbooleanfalse开启 SDK 调试日志
platform'wechat'|'alipay'|'bytedance'|'qq'|'baidu'|'swan'|'dingtalk'|'kuaishou'自动识别事件上标注的平台;运行时平台 SDK 会自动检测,一般无需手动设

采样

选项类型默认说明
sampleRatenumber1.0错误事件采样率(0.0–1.0)
tracesSampleRatenumber未设性能采样率;开启后 API 请求作为 http.client span 上报。不设则不采集性能
tracesSamplerfunction动态采样回调,按页面 / 场景返回采样率。设置后 tracesSampleRate 被忽略(优先级更高)
js
tracesSampler: ({ name, inheritOrSampleWith }) => {
  if (name.includes('pages/pay')) return 1;   // 关键页全采
  if (name.includes('pages/about')) return 0.1;
  return inheritOrSampleWith(0.5);             // 其他默认 50%
},

面包屑

选项类型默认说明
enableUserInteractionBreadcrumbsbooleantrue用户点击 / 触摸面包屑
enableNavigationBreadcrumbsbooleantrue页面生命周期 / 路由面包屑
enableConsoleBreadcrumbsbooleanfalseconsole 输出记为面包屑
enableSystemInfobooleantrue采集设备 / 系统信息作为 context
traceNetworkBodybooleanfalse网络面包屑中记录请求 / 响应体(内置敏感字段脱敏)
maxBreadcrumbsnumber100面包屑最大条数

网络面包屑(url/method/状态码/耗时)默认开启,无需配置。若开启 traceNetworkBody 后需要按 URL 排除 body,可在 beforeBreadcrumb 里按 breadcrumb.data.url 删除 request_body / response_body,或返回 null 丢弃该条面包屑。

Source Map

选项类型默认说明
enableSourceMapbooleantrue自动将各平台虚拟堆栈路径归一化为 app:/// 前缀。详见 Source Map 配置

离线缓存(弱网可靠性)

选项类型默认说明
enableOfflineCachebooleantrue断网 / 发送失败时缓存事件到本地 Storage,网络恢复后静默重试
offlineCacheLimitnumber30离线缓存最大事件数
offlineCacheMaxAgenumber86400000缓存过期时间(ms),默认 24 小时,超时丢弃

分布式追踪

选项类型默认说明
enableTracePropagationbooleantrue是否注入 sentry-trace / baggage 头。只控制传播,不关闭本地 API 请求 span
tracePropagationTargetsArray<string|RegExp>空(全部注入)仅匹配的请求才注入追踪头;为空则对所有非 Sentry 请求注入

Session 与网络

选项类型默认说明
enableAutoSessionTrackingbooleantrue自动 Session 管理,为 Sentry Release Health 提供会话数据
enableNetworkStatusMonitoringbooleantrue实时监控网络状态变化(WiFi/4G/离线)

小游戏

选项类型默认说明
enableMinigameLifecycleboolean小游戏 true / 小程序 false冷启动首帧耗时、启动场景、onShow/onHide 面包屑
enableMinigameFrameRateboolean小游戏 true / 小程序 false帧率(FPS)/ 卡顿(jank)监控;小程序无全局 rAF,开启也安全 no-op
minigameFrameRateOptionsobject见下帧率监控细调,仅 enableMinigameFrameRate 生效时使用

minigameFrameRateOptions 子项:fpsWarningThreshold(默认 30)、longFrameThresholdMs(默认 50)、reportInterval(默认 10000)、maxJankBreadcrumbsPerWindow(默认 3)。详见 支持平台与能力

过滤与钩子

选项类型默认说明
allowUrlsArray<string|RegExp>仅上报匹配这些 URL 的错误
denyUrlsArray<string|RegExp>不上报匹配这些 URL 的错误
beforeSendfunction事件发送前的钩子,可修改或返回 null 丢弃
beforeBreadcrumbfunction面包屑记录前的钩子
transportfunction内置自定义传输层(高级用法)

集成

选项类型默认说明
integrationsIntegration[]默认核心集成传入会替换核心默认集成(如 GlobalHandlers / TryCatch / PerformanceIntegration)。通常无需设置;如需在默认之上追加,用 [...Sentry.getDefaultIntegrations(), new Sentry.Integrations.XXX()]
defaultIntegrationsIntegration[]内置底层兼容字段;sentry-miniapp 会在 init 时显式组装集成,业务自定义请优先使用 integrations

默认初始化路径已含:自动异常捕获、性能监控、Source Map 路径归一化、网络面包屑、Session 与网络状态监控。其中 Source Map / 网络 / Session / 页面面包屑 / 网络状态等集成会根据顶层开关在 init 时追加。

基于 @sentry/core 的跨端小程序 SDK · MIT Licensed