Sentry 接入手册

npm install --save @sentry/vue @sentry/tracing --registry https://npm.devops.cndinfo.com/
复制代码

import * as Sentry from "@sentry/vue";

Sentry.init({
  Vue,
  dsn: "https://XXXXXXXXXX@mydsn.com/4", // 上文提到的项目 DSN 配置
  integrations: [new Sentry.BrowserTracing({})], // 配置额外的 sdk 集成
  release: process.env.SENTRY_RELEASE, // 项目的版本号，方便区分报错对应的版本；手动写死或者使用本地环境变量
  environment: "development", // 环境变量，建议和项目的环境变量保持一致（例如 development、testing、uat、production）
  attachStacktrace: true, // 是否开启堆栈跟踪（默认开），开启后跟着消息一起收集
  beforeSend: (event, hint) => {
    // 发送报错前的额外操作
    return event;
  },
  tracesSampleRate: 1.0, // 随机事件发送给 sentry 的几率
});
// 上报自定义 Tag，见下文的 setTag()
// 上报用户信息，见下文的 setUser()
复制代码

const a = {};
console.log(a.b.c);
复制代码

npm install --save-dev @sentry/webpack-plugin --registry https://npm.devops.cndinfo.com/
复制代码

const { sentryWebpackPlugin } = require("@sentry/webpack-plugin");

module.exports = {
  configureWebpack: (config) => {
    Object.assign(config, {
      plugins: [
        ...config.plugins,
        sentryWebpackPlugin({
          url: "https://sentry.devops.cndinfo.com/", // Sentry 后台地址
          release: process.env.SENTRY_RELEASE, // 和 `Sentry.init` 中的保持一致
          include: path.join(process.cwd(), "/dist"), // 需要上传到 sentry 服务器的资源目录
          ignore: ["node_modules", "vue.config.js"], // 忽略文件目录，如果在 inlcude 中已经定义了具体路径，这个参数可以不加
          authToken: process.env.SENTRY_AUTH_TOKEN, // 上文中的 User auth tokens
          org: process.env.SENTRY_ORG, // 上文中的组织名称
          project: process.env.SENTRY_PROJECT, // 上文中的项目名称
          urlPrefix: "~/static/js", // 上传资源的路径前缀，uni-app build 的路径通常是 `/static/js`, 如有变化自行更改
        }),
      ],
      // 不加这个uni-app不会生成soucemap文件
      devtool: "source-map",
    });
  },
};
复制代码

module.exports = {
  configureWebpack: {
    // 不加这个uni-app不会生成soucemap文件
    devtool: "source-map"
  }
}
复制代码

import * as Sentry from "sentry-uniapp";

Sentry.init({
  // 初始化代码同 H5, 但需要去掉 integrations
  dsn: "https://XXXXXXXXXX@mydsn.com/4", // 上文提到的项目 DSN 配置
  release: process.env.SENTRY_RELEASE, // 项目的版本号，方便区分报错对应的版本；手动写死或者使用本地环境变量
  environment: "development", // 环境变量，建议和项目的环境变量保持一致（例如 development、testing、uat、production）
  attachStacktrace: true, // 是否开启堆栈跟踪（默认开），开启后跟着消息一起收集
  beforeSend: (event, hint) => {
    // 发送报错前的额外操作
    return event;
  },
  tracesSampleRate: 1.0, // 随机事件发送给 sentry 的几率
});
// 上报自定义 Tag，见下文的 setTag()
// 上报用户信息，见下文的 setUser()
复制代码

import * as Sentry from "sentry-uniapp";

export default {
  onError: function (err) {
    // #ifdef  APP-PLUS
    const userData = uni.getStorageSync("userInfo");
    if (userData) {
      Sentry.setUser({
        id: userData.usercode,
        username: userData.username,
        email: userData.email,
        ip_address: "{{auto}}",
      });
    }
    Sentry.captureException(err);
    // #endif
  },
};
复制代码

// 一次只能上传一个 tag，若要上传多个 tag，可以添加多行
Sentry.setTag("test", "test-name");
Sentry.setTag("test_user", "test-user");
Sentry.setTag("test_id", "test123");
复制代码

Sentry.setUser({
  id: "12345",
  username: "王明",
  email: "wangming@test.com",
  ip_address: "{{auto}}",
});
复制代码

login(){
  // 登录成功并获取到用户信息后
  const userData = { id: "123", username: "test" }
  Sentry.setUser(userData);
}
复制代码

// Sentry 初始化成功后调用
// 从缓存中取用户信息，有缓存才调用
const userData = uni.getStorageSync("userInfo");
if (userData) {
  Sentry.setUser({
    id: userData.usercode,
    username: userData.username,
    email: userData.email,
    ip_address: "{{auto}}",
  });
}
复制代码

try {
  const a = {};
  console.log(a.b.c);
} catch (error) {
  Sentry.captureException(error);
}
复制代码

Sentry.init({
  // ...
  release: process.env.SENTRY_RELEASE, // 使用带子应用名称的版本号，例如 `sub_app_name@1.0.0`
  // ...
});
// 初始化之后 通过自定义的 sub_app_name 填写对应的子应用名称
Sentry.setTag("sub_app_name", "应用名称");
复制代码

// App
import * as Sentry from "sentry-uniapp";
// Web (H5)
import * as Sentry from "@sentry/vue";

uni.request({
  success:(res)=>{
    if(res.code !== 200) {
      Sentry.captureMessage("自定义上报的错误信息");
    }
  }
  fail: (err) => {
    Sentry.captureException(err);
  },
});
复制代码

try {
  const a = {};
  console.log(a.b.c);
} catch (error) {
  // 如果 catch 没有暴露错误出来 是不会被捕获的，sentry 后台不可查到
  // 需要自己手动暴露报错，或者通过 API 手动上报
  Sentry.captureException(error);
}
复制代码