Skip to content

示例工程 ​

想先确认自己的工程该在哪里初始化、如何捕获组件错误或验证上报,可以运行仓库 examples/ 中对应的示例。

示例技术栈重点演示
examples/wxapp原生微信小程序异常、请求与业务性能验证;另有实验性回放示例
examples/uniappuni-app(Vue3 + Vite)app.config.errorHandler 接 Vue 组件错误、网络面包屑
examples/taroTaro 4(React + TS)React 错误边界上报组件错误、Taro.request 面包屑

示例预置同一个演示 DSN;查看演示后台需要相应权限。自行验证时,先替换为自己的 DSN,并配置对应 AppID 的 request 合法域名。框架示例使用 app.framework 标签区分来源。

示例为了观察效果启用了全量采样、console 面包屑和正文采集;生产接入从最小配置开始,再按需要选择采集字段与采样率。

运行前准备 ​

示例使用当前源码构建,不等于安装了 npm 最新版。在仓库根目录按开发环境要求准备 Node.js 和 Yarn,然后安装依赖:

bash
corepack enable
yarn install

按项目选择构建命令,运行后在微信开发者工具打开对应项目:

要运行的示例构建与运行开发者工具打开位置
原生 wxapp根目录 yarn build:miniappexamples/wxapp
Taro根目录 yarn build,再按下方命令运行examples/taro,其配置指向 dist/
uni-app根目录 yarn build,进入 examples/uniapp 后 npm install、npm run dev:mp-weixindist/dev/mp-weixin;生产构建为 dist/build/mp-weixin

框架示例使用 npm 安装,以应用各自的 overrides;完整命令及映射检查见各示例 README。

运行(以 Taro 为例) ​

bash
yarn build          # 仓库根目录
cd examples/taro
npm install
node ../../scripts/internal/check-example-dependencies.mjs package.json
npm run dev:weapp   # 产出到 dist/,用微信开发者工具导入

确认实际结果 ​

先发送一个带独特消息的测试错误,在自己的 Sentry 项目中找到该事件;再分别验证项目需要的组件错误、请求 span 与源码位置。示例界面的“已初始化”“已采集”和事件 ID 不能代替后台接收结果。完整步骤见快速接入与Source Map 验证。

微信页面回放示例 ​

需要观察微信页面变化时,可在 SDK 源码仓库按实验性回放指南生成独立示例项目;接入自己的业务项目时,直接安装 npm 包并生成标记。Taro 与 uni-app 源码示例可用 SENTRY_REPLAY_LOCAL=1 执行原构建命令,并进入 pages/replay/index;其构建插件会自动标记。原生示例没有云端额度时使用 yarn build:replay-local 和 PC 录制查看器,本地录制与播放不请求 Sentry。

关键集成点 ​

  • 初始化封装:Taro / uni-app 在 src/utils/sentry.* 配置 SDK;原生 wxapp 在 app.js 初始化。
  • 组件错误:uni-app 在 main.js 接 errorHandler;Taro React 使用错误边界。详见 uni-app 接入与 Taro 接入。

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