[FEE-1407] 工作階段重播與正式環境除錯
INFO
工作階段重播(Session Replay)將 DOM 突變、網路活動與主控台輸出記錄成一份時間軸,讓工程師能直接觀看正式環境 bug 發生的過程,而不必從使用者描述中重建現場。當重播與錯誤追蹤相互關聯時,一份堆疊追蹤就能轉化為導致它發生的點擊與請求序列。這項技術伴隨著實際的隱私義務:重播可能捕獲 DOM 文字與表單輸入中的個人識別資訊,因此遮罩與同意閘控必須在開始錄製前就設定完成。本文涵蓋六款工作階段重播工具、GDPR 同意與遮罩機制、用於串接重播與後端日誌的關聯 ID,以及錄製對用戶端造成的成本。
背景脈絡
只在特定裝置或特定時序下才會出現的 bug,如果還依賴某種網路條件、一連串 UI 互動,或工程師難以重現的帳號資料結構,可能要花上數天才能重現,甚至完全無法重現。傳統除錯工具組(日誌、截圖、使用者回報的步驟)對這類情況力有未逮,因為它依賴使用者準確回憶並描述一連串他們根本不知道自己應該觀察的事件。
工作階段重播會記錄使用者互動發生當下的狀態:DOM 突變、捲動位置、點擊座標、網路請求與回應、主控台錯誤,以及 JavaScript 例外,全部捕獲成一份工程師可以在類瀏覽器介面中重播的時間軸。包括 Sentry 與 PostHog 在內的多款重播工具,都建立在 rrweb 之上:這是一個開源函式庫,能將 DOM 變化序列化為精簡的事件串流,並在重播時重建畫面。工程師看到的正是使用者當時所看到的內容,依照事件發生的順序呈現,不需要先重現 bug。
各工具的定位、深度與託管模式各有不同。LogRocket 是專屬的工作階段重播產品,具備高保真 DOM 錄製,以及包含請求與回應內容本體的深度網路請求審查能力。Sentry Session Replay 透過從 @sentry/browser(以及建立在其上的各框架 SDK)匯出的 replayIntegration(),直接與錯誤追蹤整合:當錯誤事件被捕獲時,Sentry 會將錯誤發生前後那段時間的工作階段重播連結附加到錯誤事件上。對已使用 Sentry 的團隊而言,錯誤與重播之間只隔了一次點擊。Microsoft Clarity 是 Microsoft 提供的免費工具,提供工作階段重播與熱圖,沒有每次工作階段的費用,對高流量應用程式相當實用。FullStory 是企業級產品,除重播功能外,還強調 DX 資料捕獲與產品分析。OpenReplay 是開源、可自行託管的重播工具;由於錄製內容留在團隊自己掌控的基礎設施上,自行託管消除了雲端託管服務商對歐盟團隊帶來的跨境傳輸疑慮。PostHog 將工作階段重播與其開源產品分析平台捆綁在一起;重播功能可以在配置了 blob 儲存的自行託管(hobby)部署上執行,但 PostHog 已不再正式支援正式環境的自行託管,轉而引導團隊改用 PostHog Cloud。
隱私是不可妥協的約束。工作階段重播會記錄使用者輸入的內容、點擊的位置,以及他們看到的畫面。這可能包括表單輸入、財務資料、健康資訊,以及其他呈現在 DOM 內容中的個人識別資訊。未經遮罩就錄製這些資料,會產生 GDPR、CCPA 與 HIPAA 的法律責任。現行 SDK 以「預設遮罩」來因應這個問題:以 Sentry 的 replayIntegration() 為例,它預設會遮罩所有文字、所有輸入欄位,並封鎖所有媒體內容,因此工程師必須明確為特定非敏感內容取消遮罩,而不是事後才發現敏感欄位被錄製了。
GDPR 與同意 增加了一層法律要求。在 GDPR(及類似法律)適用的司法管轄區,工作階段重播構成個人資料處理,通常需要在開始前取得使用者的明確同意。工作階段重播的初始化必須等待同意訊號,而不是在應用程式啟動時無條件執行。若對所有使用者啟用重播,事後才發現歐盟使用者在未同意的情況下被錄製,這會構成資料保護事件。
關聯 ID(Correlation ID) 將前端工作階段連接到後端日誌追蹤。在前端產生的工作階段 ID,作為 HTTP 標頭(X-Correlation-ID)隨每個 API 請求傳遞,讓後端工程師可以搜尋其日誌,找到觸及特定使用者工作階段的所有請求。結合工作階段重播 URL,這創造了一個完整的圖像:重播顯示使用者的體驗;關聯 ID 呈現那段時間的後端狀態。
視覺化
工作階段重播流程
以下圖表展示使用者操作如何被錄製、緩衝,並在發生錯誤時上傳,以及工程師如何從 Sentry 錯誤事件導航回工作階段重播。DOM 突變觀察器(通常以 rrweb 為基礎)會將變化序列化,存入保留最近 60 秒活動內容的記憶體環形緩衝區。錯誤觸發時,緩衝區會被刷新並上傳,產生的重播 URL 會與麵包屑(breadcrumbs,Sentry 用來稱呼導致錯誤發生前一連串點擊、導航,以及主控台或網路事件的時序軌跡)和呼叫堆疊追蹤一併附加到該錯誤事件上。
範例
1. Sentry Session Replay 設定
安裝並設定 Sentry Session Replay。從 SDK v8 開始,replayIntegration() 函式已內建於 @sentry/browser(以及建立在其上的各框架 SDK,例如 @sentry/react 與 @sentry/nextjs)中,不需要另外安裝 @sentry/replay 套件。
// src/instrument.ts(在應用程式初始化前載入)
import * as Sentry from '@sentry/browser';
Sentry.init({
dsn: 'https://YOUR_DSN@sentry.io/YOUR_PROJECT',
integrations: [
Sentry.replayIntegration({
// maskAllText、maskAllInputs、blockAllMedia 皆預設為 true。
// 保持開啟。透過 unmask 讓特定非敏感元素跳過遮罩。
unmask: ['.sentry-unmask'],
}),
],
// 對所有工作階段的 10% 進行重播抽樣,不論是否有錯誤
replaysSessionSampleRate: 0.1,
// 對產生錯誤的工作階段 100% 捕獲重播
replaysOnErrorSampleRate: 1.0,
});若要讓特定元素在重播中以未遮罩形式出現(適用於被預設 maskAllText 遮罩的非敏感 UI 內容),請新增 .sentry-unmask CSS 類別,並如上所示將該類別列入整合設定的 unmask 陣列中。在 SDK v8 及後續版本中,若沒有對應的 unmask 項目,單靠這個類別不會有任何作用:
<!-- 預設遮罩 -->
<p>使用者帳號:****</p>
<!-- 明確取消遮罩,因為 .sentry-unmask 已列在上方的 unmask 中 -->
<p class="sentry-unmask">頁面標題:儀表板</p>若要明確阻止某個元素出現在重播中(即使是遮罩後的佔位符也不顯示),新增 .sentry-block 類別:
<!-- 此元素即使作為遮罩佔位符也不會出現在重播中 -->
<div class="sentry-block">
<canvas id="signature-pad" />
</div>2. GDPR 同意閘道的重播初始化
對於服務歐盟使用者的應用程式,重播必須以同意為前提。初始化 Sentry 時保留重播整合,但將兩個重播抽樣率都設為 0,然後在使用者授予同意後呼叫 Sentry.getReplay().startBuffering()。startBuffering() 會立即開始將內容錄製進環形緩衝區,不受抽樣率設定影響,而錯誤事件仍會觸發緩衝區的刷新與上傳。
// src/instrument.ts
import * as Sentry from '@sentry/browser';
// 追蹤錯誤通常可依據合法利益進行;
// 重播需要明確同意,因此其抽樣率一開始為 0。
Sentry.init({
dsn: 'https://YOUR_DSN@sentry.io/YOUR_PROJECT',
integrations: [
Sentry.replayIntegration({
unmask: ['.sentry-unmask'],
}),
],
tracesSampleRate: 0.2,
replaysSessionSampleRate: 0,
replaysOnErrorSampleRate: 0,
});
// 在使用者於 Cookie 橫幅授予同意後呼叫此函式
export function enableSessionReplayAfterConsent(): void {
const replay = Sentry.getReplay();
if (!replay) return;
// startBuffering() 會開始錄製進環形緩衝區,但不會上傳。
// 後續的錯誤事件仍會觸發刷新,因此一旦取得同意,
// 行為就等同於 replaysOnErrorSampleRate: 1.0。
replay.startBuffering();
Sentry.getCurrentScope().setExtra('replayConsent', true);
}在你的同意管理平台處理器中:
// src/consent.ts
import { enableSessionReplayAfterConsent } from './instrument';
cookieConsentPlatform.on('consent:granted', (categories) => {
if (categories.includes('analytics')) {
enableSessionReplayAfterConsent();
}
});3. LogRocket 設定與錯誤關聯
// src/instrument.ts
import LogRocket from 'logrocket';
LogRocket.init('your-app/your-project', {
dom: {
// 清除所有輸入欄位的值——它們在重播中將顯示為星號
inputSanitizer: true,
},
network: {
// 從網路請求/回應捕獲中移除敏感標頭
requestSanitizer: (request) => {
if (request.headers['Authorization']) {
request.headers['Authorization'] = '[REDACTED]';
}
return request;
},
responseSanitizer: (response) => {
// 對敏感端點的回應內容進行編輯
if (response.url.includes('/api/payments')) {
response.body = '[REDACTED]';
}
return response;
},
},
});
// 識別使用者(在正式環境中使用 ID,不使用姓名或電子郵件)
LogRocket.identify('user-internal-id-123', {
// 僅包含非敏感識別符
plan: 'enterprise',
role: 'admin',
});將 LogRocket 工作階段 URL 附加到 Sentry 錯誤,使兩個系統相互連結:
// src/instrument.ts(續)
import * as Sentry from '@sentry/browser';
LogRocket.getSessionURL((sessionURL) => {
Sentry.getCurrentScope().setExtra('logRocketSessionURL', sessionURL);
});當 Sentry 錯誤被捕獲時,它將包含 logRocketSessionURL 額外欄位,這是該工作階段 LogRocket 重播的直接連結。
4. Microsoft Clarity(免費方案)
Microsoft Clarity 只需一個 script 標籤或一行初始化程式碼。對於想要工作階段重播但不想付費的團隊,這是最簡單的選項。
<!-- 新增至 <head>——將 PROJECT_ID 替換為你的 Clarity 專案 ID -->
<script type="text/javascript">
(function(c,l,a,r,i,t,y){
c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
})(window, document, "clarity", "script", "PROJECT_ID");
</script>或透過官方 npm 套件 @microsoft/clarity 安裝(較底層的 clarity-js 核心監測套件不是將 Clarity 加入網站的建議做法):
import Clarity from '@microsoft/clarity';
Clarity.init('PROJECT_ID');
// 以自訂識別符標記工作階段以供關聯
Clarity.setTag('userId', 'internal-user-id-123');Clarity 的個人識別資訊遮罩在 Clarity 儀表板的遮罩設定中配置。你可以透過 CSS 選擇器或元素屬性設定遮罩規則,無需更改應用程式程式碼。對於需要程式碼層級遮罩的元素:
<!-- 新增 data-clarity-mask 屬性以遮罩元素 -->
<input type="text" name="ssn" data-clarity-mask="True" />5. FullStory 設定
import * as FullStory from '@fullstory/browser';
FullStory.init({
orgId: 'YOUR_ORG_ID',
// 在非正式環境中停用捕獲
devMode: process.env.NODE_ENV !== 'production',
});
// 識別使用者(使用內部 ID,不使用個人識別資訊)
FullStory.identify('user-internal-id-123', {
displayName: 'Masked User',
// 不要在此處包含電子郵件或真實姓名
});若要遮罩或排除 FullStory 捕獲中的 DOM 元素,新增 fs-mask 或 fs-exclude CSS 類別。fs-mask 會以線框樣式的佔位內容取代文字,同時保留版面配置;fs-exclude 則會將該元素及其子樹完全從捕獲中移除:
<!-- FullStory 會以佔位內容取代這段文字 -->
<div class="fs-mask">
<span>信用卡號:4111 1111 1111 1111</span>
</div>6. 後端追蹤的關聯 ID
在應用程式啟動時產生工作階段範圍的關聯 ID,並將其附加到每個 API 請求。這讓後端工程師可以搜尋其日誌,找到來自特定前端工作階段的所有請求。
// src/correlation.ts
import { v4 as uuidv4 } from 'uuid';
// 每次頁面載入產生一次(若持久化到 sessionStorage 則每個使用者工作階段一次)
export const correlationId = sessionStorage.getItem('correlationId')
?? (() => {
const id = uuidv4();
sessionStorage.setItem('correlationId', id);
return id;
})();
// 附加到 Sentry 範圍,使其出現在每個錯誤事件中
import * as Sentry from '@sentry/browser';
Sentry.getCurrentScope().setTag('correlationId', correlationId);透過 fetch 包裝器或 Axios 攔截器,將關聯 ID 新增到每個傳出的 API 請求:
// src/api/client.ts
import { correlationId } from '../correlation';
// Fetch 包裝器
export async function apiFetch(url: string, options: RequestInit = {}): Promise<Response> {
const headers = new Headers(options.headers);
headers.set('X-Correlation-ID', correlationId);
return fetch(url, { ...options, headers });
}
// Axios 攔截器替代方案
import axios from 'axios';
axios.interceptors.request.use((config) => {
config.headers['X-Correlation-ID'] = correlationId;
return config;
});在後端,將 X-Correlation-ID 標頭記錄到每個請求日誌條目中。後端工程師隨後可以執行:
# 尋找特定前端工作階段的所有後端日誌條目
grep "X-Correlation-ID: abc-123-def" /var/log/app/access.log結合工作階段重播 URL(其 metadata 中包含相同的工作階段識別符),這建立了從前端使用者操作,通過 API 請求,到後端日誌條目的完整稽核軌跡。
7. 網路除錯的 HAR 匯出
當工作階段重播不可用,或特定網路層級問題需要深度審查時,Chrome DevTools HAR 匯出提供了完整的網路請求和回應存檔。
匯出 HAR 檔案的步驟:
- 開啟 Chrome DevTools(F12 或 Cmd+Opt+I)
- 切換到 Network 標籤
- 重現問題(或載入問題發生的頁面)
- 在網路請求列表中右鍵點擊任意位置
- 選擇「Save all as HAR with content」
匯出的 .har 檔案(JSON 格式)包含每個請求的 URL、方法、標頭(請求和回應)、狀態碼、時序分解,以及回應內容本體。與正在調查問題的工程師分享 HAR 檔案。
分享前為保護隱私,從 HAR 中清除敏感標頭:
# 在分享前從 HAR 檔案中移除 Authorization 標頭
# (需要 jq)
jq 'del(.log.entries[].request.headers[] | select(.name == "Authorization"))' \
network-capture.har > network-capture-sanitized.har8. 透過功能旗標的遠端除錯日誌
對於工作階段重播無法捕獲的問題(時序敏感的競態條件、低層級渲染 bug),透過功能旗標為特定使用者啟用詳細日誌記錄。
// src/debug-logger.ts
import { featureFlags } from './feature-flags'; // FEE-1405 模式
const isVerboseLogging = featureFlags.isEnabled('verbose-logging');
export function debugLog(message: string, context?: Record<string, unknown>): void {
if (!isVerboseLogging) return;
// 在每個除錯日誌中包含關聯 ID,使後端可以連接日誌
const entry = {
timestamp: new Date().toISOString(),
correlationId: sessionStorage.getItem('correlationId'),
message,
...context,
};
// 傳送到你的結構化日誌端點(FEE-1403 模式)
fetch('/api/debug-logs', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(entry),
}).catch(() => {
// 日誌記錄絕不能拋出例外——靜默吞噬錯誤
});
// 同時記錄到主控台以供本地除錯
console.debug('[debug]', message, context);
}透過在你的旗標管理系統(LaunchDarkly、Unleash 等)中將功能旗標定向到特定使用者 ID,僅對遭遇問題的特定使用者啟用詳細日誌記錄。
最佳實踐
必須(MUST)讓 maskAllInputs、maskAllText 與 blockAllMedia 保持在預設值 true,適用於任何可能在 DOM 文字、輸入欄位或媒體中渲染個人識別資訊的應用程式。 這些是目前 Sentry 版本(v8 及以後)的 SDK 預設值,不是需要另外開啟的設定。若在正確設定遮罩之前就捕獲了個人識別資訊,資料已經被錄製,並受 GDPR 刪除義務約束,而這在操作上可能難以履行。團隊必須(MUST)將遮罩視為預設設定:透過 .sentry-unmask 類別搭配整合設定中對應的 unmask 項目,讓特定非敏感元素跳出遮罩範圍,而不是事後才逐一為個別欄位加上遮罩。
必須(MUST)在 GDPR 適用司法管轄區,將工作階段重播的初始化限制在取得使用者明確同意之後。 工作階段重播依 GDPR 構成個人資料處理,通常需要超出合法利益的合法依據。團隊必須(MUST)初始化重播整合時,將 replaysSessionSampleRate 與 replaysOnErrorSampleRate 都設為 0,僅在使用者透過 Cookie 同意平台授予分析同意後,才呼叫 Sentry.getReplay().startBuffering()(或 .start())。對所有使用者啟用重播後才發現歐盟使用者在未同意的情況下被錄製,會構成資料保護事件。
必須(MUST)在每個傳出 API 請求標頭(X-Correlation-ID)中傳遞穩定的關聯 ID,並將其附加到 Sentry 作用域。 沒有關聯 ID,看到伺服器錯誤的後端工程師無法找到產生該請求的前端工作階段重播。團隊必須(MUST)在每個工作階段產生一次關聯 ID(持久化在 sessionStorage 中),將其作為標籤附加到 Sentry 作用域,並透過共享攔截器將其作為請求標頭包含在每個 fetch 或 Axios 呼叫中。
應該(SHOULD)將 replaysOnErrorSampleRate 設為 1.0,以捕獲每個產生錯誤的工作階段的完整重播緩衝區。 涵蓋錯誤發生前 60 秒的重播緩衝區,正是讓除錯流程從閱讀堆疊追蹤,轉變為觀看導致當機的操作序列的關鍵。團隊應該(SHOULD)將 replaysSessionSampleRate 設為較低值(0.05–0.1)用於隨機工作階段抽樣,但應該(SHOULD)保持 replaysOnErrorSampleRate 為 1.0,確保絕不錯過由錯誤觸發的重播。
應該(SHOULD)將重播工具與錯誤報告相關聯,使錯誤事件直接連結到重播。 並行運行 LogRocket 和 Sentry 但未建立連結,會迫使工程師在兩個工具中分別搜尋相同的使用者和時間窗口。團隊應該(SHOULD)呼叫 LogRocket.getSessionURL() 並將回傳的 URL 作為額外欄位附加到 Sentry 作用域,或原生使用 Sentry Session Replay 在無需額外工具的情況下實現相同的連結。
應該(SHOULD)考量錄製對用戶端造成的成本,以及工具無法捕獲的內容。 以 rrweb 為基礎的工具所依賴的 DOM 突變觀察器,會增加封裝體積,並帶來與頁面變化頻率成正比的持續 CPU 成本;高頻率的 canvas 或 WebGL 渲染可能產生大量突變事件。canvas 與 WebGL 內容、跨來源 iframe,以及 shadow DOM 內容,通常都需要額外的工具專屬設定才能被捕獲,而某些內容無論如何設定都無法錄製。團隊應該(SHOULD)在大規模推行前,針對具代表性的頁面在啟用重播的情況下進行效能剖析,並記錄所選工具無法捕獲的 UI 範圍。
不應該(SHOULD NOT)將工作階段重播資料保存超過資料保留政策的要求。 工作階段重播資料在 GDPR 下屬於個人資料,須符合資料最小化要求:不得保存超過其聲明用途所必需的期限。保留期限通常由提供商的方案等級或你自行設定的政策決定,並非單一的通用預設值,且因提供商而異。團隊應該(SHOULD)確認提供商可設定的保留範圍,將其設為仍能滿足團隊除錯需求的最短期限,並明確使其與組織的隱私政策一致。
不應該(SHOULD NOT)在測試或開發環境中錄製工作階段重播。 測試環境包含看起來像真實資料的測試帳號、模擬敏感操作的開發工作流程,以及不應儲存在第三方重播提供商的除錯狀態。團隊應該(SHOULD)以 process.env.NODE_ENV === 'production' 為條件閘控重播初始化,並在非正式環境中將兩個抽樣率都設為 0。
設計思維
為何工作階段重播改變了正式環境除錯
在工作階段重播出現之前,重現正式環境 bug 需要以下三者之一:(1) 任何工程師都能在測試環境中遵循的可靠步驟;(2) 存取使用者的特定裝置與帳號狀態;或 (3) 純粹的運氣。依賴時序、網路條件、瀏覽器版本、帳號資料結構,或特定 UI 互動序列的 bug,經常因為這三個條件都無法滿足而懸而未決。
工作階段重播消除了重現這個步驟:工程師不需要重現 bug,而是直接觀看它發生的過程。重播顯示失敗當下的確切 DOM 狀態、其之前的網路請求、主控台錯誤,以及觸發它們的使用者操作。過去被歸在「無法重現」待辦清單中的 bug,在單次工作階段中就能解決。
第二階效應發生在組織層面:客戶支援可以將使用者投訴連結到重播,附上 URL 後升交工程師,工程師無需與使用者交流就能掌握完整脈絡。過去需要支援票單、來回澄清,以及最佳猜測重現嘗試的資訊傳遞,被 90 秒的播放取代。
為何隱私必須從一開始就設計進去
事後補救的隱私保護容易出錯。若在沒有遮罩的情況下部署重播並捕獲了個人識別資訊,資料就已經被錄製了。要從重播提供商的儲存中刪除,需要使用他們的刪除 API 或走一次手動請求流程。GDPR 的刪除義務同樣適用於重播資料,而重播提供商的資料保留時程,可能與你需要的刪除時程不一致。
事後遮罩敏感欄位,需要在每一個頁面、每一個元件、每一個第三方小工具中,識別出所有可能包含個人識別資訊的欄位。這與安全設計原則相反:你試圖列舉需要保護的內容,風險就在於你遺漏了什麼。從另一個方向設計,也就是預設遮罩所有內容,工程師再明確為除錯所需的內容取消遮罩,風險便轉移到你不必要暴露了什麼,而這是一個更小、更容易稽核的集合。
對於 Sentry 的實際意涵是:maskAllInputs、maskAllText 與 blockAllMedia 在目前的 SDK 版本(v8 及以後)中都預設為 true。遮罩不需要額外的選擇加入步驟,預設值本身就已經保守。剩下的工作與早期 SDK 版本的要求相反:找出重播中需要可見的一小群非敏感元素,為它們加上 .sentry-unmask 類別,並將該類別列入整合設定的 unmask 陣列中(replayIntegration({ unmask: ['.sentry-unmask'] }))。在 SDK v8 及後續版本中,若沒有對應的 unmask 設定項目,單靠這個類別不會有任何作用。
資料駐留
資料駐留(Data residency)是與同意機制不同的獨立考量:它決定重播資料儲存在哪個地理區域。根據 GDPR,將個人資料傳輸至歐盟以外地區,需要適足性認定或適當的保障措施。大多數重播提供商都提供歐盟區域部署選項:Sentry 在 sentry.io/eu/ 提供歐盟主機版本,LogRocket 也提供歐盟資料儲存。企業合約可能要求資料主權保證。請在上線前確認提供商的資料駐留設定;即使是歐盟團隊,預設值往往仍是美國區域儲存。
自行託管繞開了傳輸問題,而不只是管理它。OpenReplay 提供可自行託管的部署方式,讓團隊能將重播錄製內容留在自己的基礎設施與司法管轄範圍內,而不必仰賴廠商提供的區域部署選項。PostHog 將工作階段重播與其分析平台捆綁在一起,重播功能可以在配置了 blob 儲存的自行託管部署上執行。但 PostHog 已不再正式支援正式環境的自行託管,因此需要駐留保證的團隊,應將 PostHog Cloud 的區域選項視為受支援的路徑,而非依賴自行託管。
重播與錯誤事件的關聯
單一的 Sentry 錯誤事件能告訴你出了什麼問題:例外類型、呼叫堆疊追蹤、瀏覽器版本、受影響的 URL。它無法告訴你的是,使用者在錯誤觸發前 60 秒做了什麼。透過 replaysOnErrorSampleRate: 1.0,Sentry 會為每個工作階段緩衝重播,並在發生錯誤時刷新並上傳緩衝區,將重播 URL 附加到 Sentry UI 中的錯誤事件上。
實際的效果很具體:在 Sentry 中點擊一個錯誤,就會開啟一份顯示當機前 DOM 狀態、網路請求與使用者操作的重播,工程師只要觀看就能重建失敗序列,不必單靠堆疊追蹤來推測。
對於尚未使用 Sentry 的團隊,LogRocket 從另一個方向提供了相同的關聯模式:LogRocket.getSessionURL(sessionURL => ...) 會回傳一個 URL,可以附加到任何錯誤回報呼叫中,在錯誤事件與重播之間建立相同的雙向連結。
LogRocket 與 Sentry Session Replay 如何選擇
LogRocket 和 Sentry Session Replay 有顯著的重疊,但深度不同。LogRocket 是專屬的重播產品,網路審查更豐富:它捕獲請求和回應內容本體,而不僅僅是標頭和狀態碼。它還提供 Sentry 沒有的產品分析層(使用者旅程漏斗、點擊地圖)。對於主要使用場景是深度除錯正式環境問題和理解使用者行為的團隊,LogRocket 的額外監控能力很有價值。
Sentry Session Replay 對於已使用 Sentry、想要單一工具而非兩份合約的團隊是更好的選擇。錯誤與重播的關聯是原生支援,不需要額外的整合程式碼。錯誤預算的角度也有利於 Sentry:在 Sentry 中管理錯誤率、SLO 和告警的同一個團隊,無需切換工具或維護第二個資料管道就能獲得重播脈絡。
決策點通常是組織層面的:如果你的團隊已經支付 Sentry 費用,且重播保真度滿足你的除錯需求(對絕大多數 bug 而言確實如此),那麼新增 LogRocket 是一筆需要自我證明的額外成本。如果你的團隊不使用 Sentry,或者網路級請求內容審查對你的除錯工作流程至關重要,LogRocket 值得額外投資。
工具比較
| 工具 | 託管方式 | 錯誤關聯 | 遮罩設定 | 最適合的情境 |
|---|---|---|---|---|
| Sentry Session Replay | 雲端(美國或歐盟區域) | 原生支援:replaysOnErrorSampleRate 會將重播附加到錯誤事件 | maskAllText、maskAllInputs、blockAllMedia 皆預設為 true;透過 .sentry-unmask + unmask 設定為特定元素取消遮罩 | 已使用 Sentry 進行錯誤追蹤的團隊 |
| LogRocket | 雲端(美國或歐盟區域) | 手動:將 LogRocket.getSessionURL() 附加到錯誤回報中 | inputSanitizer 與請求/回應清理函式 | 需要深度網路內容審查,並內建產品分析 |
| Microsoft Clarity | 雲端(Microsoft 託管) | 未內建;需與你的錯誤工具手動關聯 | 儀表板遮罩規則或 data-clarity-mask 屬性 | 高流量網站,需要免費的重播與熱圖 |
| FullStory | 雲端(美國或歐盟區域) | 手動:將 FullStory 工作階段參照附加到你的錯誤工具 | fs-mask / fs-exclude CSS 類別或儀表板規則 | 企業級 UX 研究搭配重播 |
| OpenReplay | 自行託管(開源)或代管雲端 | 手動:將 OpenReplay 工作階段 URL 附加到你的錯誤工具 | 依專案設定的編修規則 | 有資料駐留或自行託管需求的團隊 |
| PostHog | 可自行託管(hobby)或使用 Cloud;正式環境自行託管已不再受官方支援 | 若使用 PostHog 自身的錯誤追蹤則為原生支援;否則需手動 | 屬性與元素層級的遮罩設定 | 已將 PostHog 用於分析、旗標與實驗的團隊 |
延伸閱讀
- FEE-1400:可觀測性與錯誤追蹤總覽 — 分類脈絡;工作階段重播是三個可觀測性支柱的使用者面向層
- FEE-1401:使用 Sentry 進行錯誤追蹤 — Sentry 錯誤事件連結到工作階段重播;
replaysOnErrorSampleRate是連接它們的配置 - FEE-1403:日誌記錄與結構化日誌 — 結構化日誌中的關聯 ID 讓後端日誌追蹤能與重播中捕獲的前端工作階段相連結
- FEE-1405:功能旗標可觀測性與 A/B 測試 — 功能旗標狀態在重播脈絡中可見;遠端除錯日誌(特定使用者的詳細模式)由功能旗標控制
參考資料
- Sentry — Session Replay 文件
- Sentry — Session Replay 隱私與遮罩
- Sentry — replayIntegration() API 參考
- Sentry — 了解工作階段(手動啟動/startBuffering)
- LogRocket — 入門指南
- LogRocket — 個人識別資訊與資料隱私
- LogRocket — getSessionURL API
- Microsoft Clarity — 文件
- Microsoft Clarity — 遮罩設定
- FullStory — 入門指南
- FullStory — 如何保護使用者隱私(fs-mask / fs-exclude)
- OpenReplay — 開源、可自行託管的工作階段重播
- PostHog — 工作階段重播文件
- rrweb — 開源 DOM 錄製函式庫(底層技術)
- W3C HAR 規範
- GDPR — 第 6 條:處理的合法性
- OWASP — 工作階段管理備忘單