Sentry 小程序/小游戏 SDK 安装和配置指南

1. 项目基础介绍和主要编程语言

项目基础介绍

sentry-miniapp 是一个用于小程序/小游戏平台的 Sentry SDK。它支持多种小程序平台，包括微信、字节跳动、支付宝、钉钉、QQ、百度小程序以及微信、QQ 小游戏。该项目的主要目的是帮助开发者在小程序和小游戏中集成 Sentry 的错误监控功能，以便更好地管理和调试应用程序中的错误。

主要编程语言

该项目主要使用 TypeScript 进行编写，同时也包含部分 JavaScript 代码。

2. 项目使用的关键技术和框架

关键技术

• Sentry SDK: 基于 sentry-javascript 最新的基础模块封装，提供统一的 API 设计。
• TypeScript: 用于编写 SDK 的核心代码，提供类型检查和更好的开发体验。
• Webpack: 用于构建和打包 SDK，支持多种小程序平台的特定配置。

框架支持

• 微信小程序
• 字节跳动小程序
• 支付宝小程序
• 钉钉小程序
• QQ 小程序
• 百度小程序
• 微信小游戏
• QQ 小游戏

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

1. Node.js 和 npm: 确保你已经安装了 Node.js 和 npm。你可以通过运行 node -v 和 npm -v 来检查是否已安装。
2. 微信开发者工具: 如果你使用的是微信小程序或微信小游戏，需要安装微信开发者工具。
3. Sentry 账号: 你需要在 Sentry 上创建一个项目，并获取 DSN (Data Source Name)。

安装步骤

1. 克隆项目

首先，克隆 sentry-miniapp 项目到本地：

git clone https://github.com/lizhiyao/sentry-miniapp.git
cd sentry-miniapp

2. 安装依赖

在项目根目录下运行以下命令来安装依赖：

npm install

3. 构建 SDK

根据你使用的小程序平台，选择相应的构建命令。例如，如果你使用的是微信小程序，可以运行：

npm run build:wx

其他平台的构建命令如下：

• 支付宝小程序: npm run build:my
• 字节跳动小程序: npm run build:tt
• 钉钉小程序: npm run build:dd
• 百度小程序: npm run build:swan

4. 配置 Sentry

在你的小程序项目中，找到 app.js 文件，并添加以下代码来初始化 Sentry：

import * as Sentry from 'sentry-miniapp';

// 初始化 Sentry
Sentry.init({
  dsn: '__YOUR_DSN_HERE__', // 替换为你的 Sentry DSN
});

// 配置 Sentry 作用域
Sentry.configureScope((scope) => {
  scope.setExtra('battery', 0.7);
  scope.setTag('user_mode', 'admin');
  scope.setUser({ id: '4711' });
});

// 捕获异常
Sentry.captureException(new Error('Good bye'));
Sentry.captureMessage('Hello, world!');

5. 配置合法域名

在小程序管理后台，配置 Sentry Service 对应的 request 合法域名。

6. 运行和测试

使用微信开发者工具打开你的小程序项目，确保 Sentry 初始化代码正确运行，并测试错误上报功能。

注意事项

• 无论选择哪种使用方式，都需要开启「微信开发者工具 - 设置 - 项目设置 - 增强编译」功能。
• 使用前需要确保有可用的 Sentry Service，比如使用官方 Sentry Service 服务或自己搭建 Sentry Service。

通过以上步骤，你就可以成功地在你的小程序或小游戏中集成 Sentry 的错误监控功能了。