Sentry-taro-miniapp NPM

Sentry Taro SDK

Fork sentry-miniapp 改造而来

用于Taro小程序的 Sentry SDK

功能特点

基于 sentry-javascript 最新的基础模块封装
使用 TypeScript 进行编写
包含 Sentry SDK（如：@sentry/browser）的所有基础功能
支持 ES6、CommonJS 两种模块系统（支持小程序原生开发方式、使用小程序框架开发方式两种开发模式下使用）
默认监听并上报小程序的 onError、onUnhandledRejection、onPageNotFound、onMemoryWarning 事件返回的信息（各事件支持程度与对应各小程序官方保持一致）
默认上报运行小程序的设备、操作系统、应用版本信息
支持微信小程序
支持在 Taro 等第三方小程序框架中使用
默认上报异常发生时的路由栈
完善的代码测试
支持 redux 错误上报
支持 webview 错误上报

用法

支持两种使用方式：

直接引用
通过 npm 方式使用（推荐）

注意

使用前需要确保有可用的 Sentry Service，比如：使用官方 Sentry Service 服务或自己搭建 Sentry Service。如果想直接将异常信息上报到 https://sentry.io/，由于其没有备案，可以先将异常信息上报给自己已备案域名下的服务端接口，由服务端进行请求转发。
在小程序管理后台配置 Sentry Service 对应的 request 合法域名

npm 方式

安装依赖

npm install sentry-taro-miniapp --save
# 或者
yarn add sentry-taro-miniapp

使用「微信开发者工具 - 工具 - 构建 npm」进行构建，详情可参考npm 支持

在 app.js 中引用并初始化 Sentry，根据实际需求设置上报到 Sentry 的元信息

import * as Sentry from "sentry-taro-miniapp";

// init Sentry
// init options: https://github.com/getsentry/sentry-javascript/blob/master/packages/types/src/options.ts
Sentry.init({
  dsn: "__DSN__",
  // ...
});

// Set user information, as well as tags and further extras
Sentry.configureScope((scope) => {
  scope.setExtra("battery", 0.7);
  scope.setTag("user_mode", "admin");
  scope.setUser({ id: "4711" });
  // scope.clear();
});

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
  message: "My Breadcrumb",
  // ...
});

// Capture exceptions, messages or manual events
Sentry.captureException(new Error("Good bye"));
Sentry.captureMessage("Hello, world!");
Sentry.captureEvent({
  message: "Manual",
  stacktrace: [
    // ...
  ],
});