Toucan-JS 使用教程
toucan-js Cloudflare Workers client for Sentry 项目地址: https://gitcode.com/gh_mirrors/to/toucan-js
1. 项目介绍
Toucan-JS 是一个专为 Cloudflare Workers 设计的 Sentry 客户端,使用 TypeScript 编写。它具有以下特点:
- 可靠:在 Cloudflare Workers 的隔离模型中,Toucan-JS 避免了全局状态的设置或突变,确保没有竞态条件、未送达的日志或无意义的元数据。
- 灵活:支持 fetch 和 scheduled Workers,以及它们的
.mjs
等价物和 Durable Objects。 - 熟悉的 API:遵循 Sentry 统一的 API 指南,易于上手。
2. 项目快速启动
安装
首先,确保你已经安装了 Node.js 和 npm。然后,通过 npm 安装 Toucan-JS:
npm install toucan-js
初始化
在你的 Cloudflare Worker 项目中,初始化 Toucan-JS:
import Toucan from 'toucan-js';
addEventListener('fetch', (event) => {
const sentry = new Toucan({
dsn: 'YOUR_SENTRY_DSN',
context: event,
allowedHeaders: ['user-agent'],
allowedSearchParams: /(.*)/,
});
event.respondWith(handleRequest(event, sentry));
});
async function handleRequest(event, sentry) {
try {
// 你的业务逻辑代码
return new Response('Hello World', { status: 200 });
} catch (err) {
sentry.captureException(err);
return new Response('Internal Server Error', { status: 500 });
}
}
运行
使用 Cloudflare Workers 的命令行工具 wrangler
来部署和运行你的 Worker:
wrangler publish
3. 应用案例和最佳实践
应用案例
- 错误监控:在生产环境中,使用 Toucan-JS 捕获和报告错误,确保应用的稳定性和可靠性。
- 性能监控:通过 Sentry 的性能监控功能,跟踪和优化 Worker 的性能。
最佳实践
- 配置合理的 DSN:确保你的 Sentry DSN 配置正确,以便错误能够正确上报到 Sentry 平台。
- 捕获所有异常:在关键业务逻辑中,使用
try-catch
捕获所有可能的异常,并通过sentry.captureException
上报。
4. 典型生态项目
- Cloudflare Workers:Toucan-JS 是专为 Cloudflare Workers 设计的,因此与 Cloudflare Workers 生态紧密结合。
- Sentry:Toucan-JS 是 Sentry 的客户端,与 Sentry 平台无缝集成,提供强大的错误监控和性能分析功能。
- TypeScript:Toucan-JS 使用 TypeScript 编写,适合 TypeScript 开发者使用。
通过以上步骤,你可以快速上手并使用 Toucan-JS 进行错误监控和性能优化。
toucan-js Cloudflare Workers client for Sentry 项目地址: https://gitcode.com/gh_mirrors/to/toucan-js