{"repo":"lizhiyao/sentry-miniapp","free":true,"listed":false,"github":"https://github.com/lizhiyao/sentry-miniapp","clone":"git clone https://github.com/lizhiyao/sentry-miniapp.git","description":"Cross-platform Sentry SDK for Mini Programs & Mini Games — error monitoring, performance monitoring, Source Maps and end-to-end tracing | 跨端小程序 / 小游戏监控 SDK","language":"TypeScript","stars":677,"topics":["sentry","alipay-miniprogram","bytedance-miniprogram","distributed-tracing","error-monitoring","error-tracking","mini-program","performance-monitoring","sourcemap","taro"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Sentry Miniapp SDK — 小程序监控 SDK 简体中文 English 一个基于 @sentry/core 核心构建的 小程序监控 SDK ，提供 异常监控 、 性能监控 、离线缓存、分布式追踪等能力。支持微信、支付宝、字节跳动、百度、QQ、钉钉、快手等多端小程序，以及微信 / 抖音等 小游戏 ，并兼容 Taro / uni-app 等跨端框架。 小程序运行时没有浏览器 window / fetch / XMLHttpRequest ，本 SDK 会使用各平台的小程序 API 完成事件上报与自动捕获。如果你的目标是 H5 页面，请使用官方 @sentry/browser ；如果目标是小程序或小游戏，用本 SDK。 📖 接入细节与生产配置 ：sentry-miniapp.pages.dev —— 快速接入、框架指南、配置项、Source Map、FAQ、示例工程都在文档站。 📰 最新文章 ：《我给 Sentry 提了个 PR，后来 sentry-miniapp 进了官方文档》 — sentry-miniapp 已被收录进 Sentry 官方文档的 community-supported SDK 列表。觉得有用请帮忙点个 ⭐ Star，让更多小程序团队找到它。 --- ✨ 核心能力与适用场景 - 异常自动捕获 ：自动捕获全局异常、Promise rejection、页面异常和内存告警，把问题送进 Sentry Issues，而不是只停留在用户反馈里。 - 排查上下文 ：记录设备信息、页面生命周期、点击 / 触摸和网络请求面包屑，帮助还原用户出错前做了什么。 - 性能与链路追踪 ：采集启动、页面渲染、资源加载和 API 请求耗时；开启 tracing 后，请求可作为 http.client span 串联后端链路。 - Source Map 友好 ：统一多平台虚拟堆栈路径为 app:/// ，配合 Source Map / Debug ID 还原源码位置；特殊运行时可用 stackParser 适配。 - 弱网与合规场景 ：上报失败会先进本地离线队列，网络恢复后自动重试；开启 requireConsent 后，事件只写入本地缓冲，不向 Sentry 发起请求，用户同意后再调用 Sentry.setConsent(true) 补发。 - 小游戏专属能力 ：微信 / 抖音小游戏可采集冷启动首帧、FPS 和 jank，便于定位卡顿和首帧慢问题。 - 熟悉的 Sentry API ：支持 captureException 、 setUser 、 addBreadcrumb 、 startSpan 、 captureFeedback 、 Sentry.logger. 等常用能力。 --- 🚀 5 分钟跑通 接入前确认 ： - 已有可用的 Sentry 服务（Sentry SaaS 或自托管实例均可），并在 Sentry 中创建好项目、复制该项目的 DSN。 - 小程序后台已把 Sentry 上报域名加入 request 合法域名。 安装： 不使用 npm 时，可从 GitHub Releases 下载对应版本的 sentry-miniapp.umd.js ；调试源码仓库中的微信示例时，运行 yarn build:miniapp 生成示例依赖。 在入口文件（ app.js / app.ts ） 最顶部、 App() 之前 初始化： 验证是否打通： 然后到 Sentry 的 Issues 列表查看事件。 没看到事件时，优先确认 DSN、合法域名","default_branch":null,"files":null,"tree":[],"storefront":"/r/lizhiyao","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/lizhiyao/sentry-miniapp/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}