錯誤追蹤整合工具 是做什麼的?
將錯誤追蹤服務整合至應用程式中,以提升生產環境的除錯與監控能力。
使用時機
- 使用者要求錯誤監控或追蹤
- 設定生產環境的錯誤日誌
- 使用者提及「Sentry」、「錯誤追蹤」、「崩潰回報」或「生產環境除錯」
使用說明
1. 偵測框架
辨識應用程式框架:
- React、Vue、Angular(前端)
- Express、Fastify(Node.js 後端)
- Django、Flask(Python)
- Rails(Ruby)
2. 選擇錯誤追蹤服務
熱門服務:
- Sentry:最受歡迎,功能完整
- Rollbar:適合後端
- Bugsnag:跨平台
- Airbrake:以 Ruby 為焦點
- LogRocket:階段回放 + 錯誤
3. 安裝與配置
Sentry(React 範例):
npm install @sentry/react
import * as Sentry from "@sentry/react";
Sentry.init({
dsn: process.env.REACT_APP_SENTRY_DSN,
environment: process.env.NODE_ENV,
tracesSampleRate: 1.0,
integrations: [
new Sentry.BrowserTracing(),
new Sentry.Replay()
],
});
Sentry(Node.js/Express):
const Sentry = require("@sentry/node");
Sentry.init({
dsn: process.env.SENTRY_DSN,
environment: process.env.NODE_ENV,
tracesSampleRate: 1.0,
});
// 請求處理器(第一個中介軟體)
app.use(Sentry.Handlers.requestHandler());
// 錯誤處理器(在所有路由之後,錯誤中介軟體之前)
app.use(Sentry.Handlers.errorHandler());
4. 加入錯誤邊界(React)
import { ErrorBoundary } from '@sentry/react';
function App() {
return (
<ErrorBoundary fallback={<ErrorFallback />}>
<YourApp />
</ErrorBoundary>
);
}
5. 加入上下文
使用者上下文:
Sentry.setUser({
id: user.id,
email: user.email,
username: user.username
});
標籤:
Sentry.setTag("page_locale", "en-US");
Sentry.setTag("feature_flag", "new_ui");
上下文:
Sentry.setContext("order", {
id: order.id,
total: order.total,
items: order.items.length
});
6. 麵包屑
追蹤導致錯誤的使用者操作:
Sentry.addBreadcrumb({
category: "auth",
message: "User logged in",
level: "info"
});
Sentry.addBreadcrumb({
category: "ui",
message: "Button clicked",
data: { buttonId: "submit-form" }
});
7. 手動錯誤捕捉
try {
riskyOperation();
} catch (error) {
Sentry.captureException(error, {
tags: { section: "payment" },
level: "error",
extra: { orderId: order.id }
});
}
8. 過濾敏感資料
清除個人識別資訊(PII):
Sentry.init({
beforeSend(event, hint) {
// 若包含敏感資料則不發送
if (event.request?.data?.password) {
delete event.request.data.password;
}
return event;
},
ignoreErrors: [
// 忽略瀏覽器擴充功能錯誤
/extensions\//i,
/^Non-Error promise rejection/,
]
});
9. Source Maps(生產環境)
啟用 Source Map 以獲得可讀的堆疊追蹤:
Webpack:
// webpack.config.js
module.exports = {
devtool: 'source-map',
plugins: [
new SentryWebpackPlugin({
org: "your-org",
project: "your-project",
authToken: process.env.SENTRY_AUTH_TOKEN,
include: "./dist",
}),
],
};
10. 警報設定
設定下列項目的警報:
- 新問題
- 迴歸(已解決的問題再次發生)
- 錯誤率飆升
- 重大錯誤(支付、驗證失敗)
11. 效能監控
加入交易追蹤:
const transaction = Sentry.startTransaction({
name: "processOrder",
op: "task"
});
try {
await processOrder();
} finally {
transaction.finish();
}
12. 最佳實踐
- 環境區隔:開發/暫存/生產使用不同的專案
- 版本追蹤:用發行版本標記錯誤
- 取樣率:錯誤 100%,效能降低取樣率
- 團隊通知:Slack/電子郵件整合
- 問題指派:自動指派給程式碼負責人
- 錯誤分組:自訂指紋辨識以獲得更好的分組
- 不記錄敏感資料:個人識別資訊、密碼、令牌
支援檔案
templates/sentry-react.js:React 整合範本templates/sentry-node.js:Node.js 整合範本templates/sentry-python.py:Python 整合範本