yxt-sentry-uniapp

v1.1.3

Published

9 months ago

用于Uniapp/小程序/APP等平台的 Sentry SDK

Downloads

0High
0Medium
0Low

emmafgy

sentry uniapp uniapp app sentry uniapp sentry

sentry相关组件版本说明

sentry web : 24.1.1
sentry sdk : 7.99.0
sentry cli : 2.27.0

Sentry 小程序 SDK

Sentry SDK 的封装，可用于Uniapp全端(包含APP)，及微信小程序，抖音小程序，百度小程序等各家平台。

提示：由于快应用 require 方式特殊性，webpack是在编译期处理的，所以动态代码检测无效，使用时去更改webpack配置也增加了复杂行，所以单独维护，包名为 sentry-quickapp。

快应用项目可参考：

https://github.com/uappkit/sentry-quickapp

功能特点

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

用法

通过 npm 方式使用（推荐）

注意

无论选择哪种使用方式，都需要开启「微信开发者工具 - 设置 - 项目设置 - 增强编译」功能
使用前需要确保有可用的 Sentry Service，比如：使用官方 Sentry Service 服务或自己搭建 Sentry Service。如果想直接将异常信息上报到 https://sentry.io/，由于其没有备案，可以先将异常信息上报给自己已备案域名下的服务端接口，由服务端进行请求转发。
在小程序管理后台配置 Sentry Service 对应的 request 合法域名

npm 方式

注意：目前字节跳动小程序不支持 npm 方式。

安装依赖

npm install yxt-sentry-uniapp --save
# 或者
yarn add yxt-sentry-uniapp

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

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

import * as Sentry from "sentry-uniapp";

// init Sentry
// init options: https://github.com/getsentry/sentry-javascript/blob/master/packages/types/src/options.ts
// extraOptions 可以禁用哪些监听事件，定义见: GlobalHandlersIntegrations
// 例如出现 LOG: API `onMemoryWarning` is not yet implemented，可通过 `onmemorywarning: false` 关闭
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
// Error 无法定义标题，可以用下面的 captureMessage
Sentry.captureException(new Error("Good bye"));
 
// captureMessage 可以定制消息标题
// extra 为附加的对象内容
Sentry.captureMessage("message title", {
  extra
});
 
Sentry.captureEvent({
  message: "Manual",
  stacktrace: [
    // ...
  ],
});