簡介
網路錯誤記錄 (NEL) 是一種從來源收集用戶端網路錯誤的機制。
這個外掛程式會使用 NEL
HTTP 回應標頭來指示瀏覽器收集網路錯誤,然後與 Reporting API 整合,向伺服器回報錯誤。
舊版 Reporting API 總覽
舊版 Report-To
標頭
如要使用舊版 Reporting API,您必須設定 Report-To
HTTP 回應標頭。其值是一個物件,用來說明瀏覽器要回報錯誤的端點群組:
Report-To:
{
"max_age": 10886400,
"endpoints": [{
"url": "https://analytics.provider.com/browser-errors"
}]
}
如果端點網址所在的來源與網站不同,端點應支援 CORS 預檢要求。(例如 Access-Control-Allow-Origin: *; Access-Control-Allow-Methods: GET,PUT,POST,DELETE,OPTIONS; Access-Control-Allow-Headers: Content-Type, Authorization, Content-Length, X-Requested-With
)。
在這個範例中,透過主頁面傳送這個回應標頭會設定瀏覽器向端點 https://analytics.provider.com/browser-errors
回報瀏覽器產生的警告,持續 max_age
秒。請特別注意,系統會忽略頁面提出的所有後續 HTTP 要求 (針對圖片、指令碼等)。您必須在主頁面回應期間進行設定。
標頭欄位的說明
每個端點設定都包含 group
名稱、max_age
和 endpoints
陣列。您也可以使用 include_subdomains
欄位選擇是否要在回報錯誤時考慮子網域。
欄位 | 類型 | 說明 |
---|---|---|
group |
字串 | 選用設定。如未指定 group 名稱,則端點的名稱會是「default」。 |
max_age |
號碼 | 必填。非負整數,以秒為單位定義端點的生命週期。如果這個值為「0」,系統就會將該端點群組從使用者代理程式的報表快取中移除。 |
endpoints |
陣列<物件> | 必填。指定報表收集器實際網址的 JSON 物件陣列。 |
include_subdomains |
boolean | 選用設定。這個布林值可為目前來源主機的所有子網域啟用端點群組。如果省略或省略任何「true」,子網域則不會回報給端點。 |
group
名稱是不重複的名稱,可用於將字串與端點建立關聯。請在與 Reporting API 整合的其他地方使用這個名稱,來指稱特定端點群組。
max-age
也是必填欄位,並指定瀏覽器應使用端點的時間長度,並向端點回報錯誤。
endpoints
欄位是一個陣列,用於提供容錯移轉和負載平衡功能。請參閱容錯移轉和負載平衡一節。請注意,即使群組在 endpoints
中列出多個收集器,瀏覽器也只會選取一個端點。如要一次將報表傳送至多個伺服器,後端就必須轉送報表。
瀏覽器如何傳送報告?
瀏覽器會定期批次傳送報表,並傳送至您設定的報表端點。
為了傳送報表,瀏覽器會透過 Content-Type: application/reports+json
發出 POST
要求,並在主體包含已擷取的警告/錯誤陣列。
瀏覽器何時傳送報告?
應用程式會以非架構的方式提供報表,這表示瀏覽器控管報表傳送到伺服器的時間。
瀏覽器會嘗試在最適當的時間傳送排入佇列的報表。瀏覽器可能在完成時立即完成 (以便及時提供意見回饋),但如果瀏覽器忙於處理優先順序較高的工作,或是使用者當時的網路速度緩慢和/或壅塞,也可能會延後傳送。如果使用者是經常造訪的特定來源,瀏覽器也可能會優先傳送有關特定來源的報表。
使用 Reporting API 時,幾乎或沒有發生效能問題 (例如與應用程式的網路爭用)。此外,也無法控制瀏覽器傳送佇列報表的時機。
設定多個端點
單一回應可透過傳送多個 Report-To
標頭,一次設定多個端點:
Report-To: {
"group": "default",
"max_age": 10886400,
"endpoints": [{
"url": "https://example.com/browser-reports"
}]
}
Report-To: {
"group": "network-errors-endpoint",
"max_age": 10886400,
"endpoints": [{
"url": "https://example.com/network-errors"
}]
}
也可以將這些參數合併成單一 HTTP 標頭
Report-To: {
"group": "network-errors-endpoint",
"max_age": 10886400,
"endpoints": [{
"url": "https://example.com/network-errors"
}]
},
{
"max_age": 10886400,
"endpoints": [{
"url": "https://example.com/browser-errors"
}]
}
傳送 Report-To
標頭後,瀏覽器會根據端點的 max_age
值快取端點,並將所有惡意主控台警告/錯誤傳送至您的網址。
容錯移轉和負載平衡
在多數情況下,您需為每個群組設定一個網址收集器。不過,由於報告可能會產生大量流量,因此規格包含以 DNS SRV 記錄為靈感的容錯移轉和負載平衡功能。
瀏覽器會盡力將報表傳送至群組中的最多一個端點。您可以為端點指派 weight
,以分配負載,讓每個端點接收指定比例的報表流量。端點也可以指派 priority
,設定備用收集器。
只有在上傳至主要收集器失敗時,系統才會嘗試備用收集器。
範例:在 https://backup.com/reports
中建立備用收集器:
Report-To: {
"group": "endpoint-1",
"max_age": 10886400,
"endpoints": [
{"url": "https://example.com/reports", "priority": 1},
{"url": "https://backup.com/reports", "priority": 2}
]
}
設定網路錯誤記錄
設定
如要使用 NEL,請透過使用已命名群組的收集器設定 Report-To
標頭:
Report-To: {
...
}, {
"group": "network-errors",
"max_age": 2592000,
"endpoints": [{
"url": "https://analytics.provider.com/networkerrors"
}]
}
接下來,請傳送 NEL
回應標頭,開始收集錯誤。由於來源選擇啟用 NEL,因此只需傳送一次標頭。NEL
和 Report-To
都會套用至日後對相同來源的要求,也會繼續根據用於設定收集器的 max_age
值收集錯誤。
標頭值應為包含 max_age
和 report_to
欄位的 JSON 物件。請使用後者參照網路錯誤收集器的群組名稱:
GET /index.html HTTP/1.1
NEL: {"report_to": "network-errors", "max_age": 2592000}
子資源
範例:如果 example.com
載入 foobar.com/cat.gif
且該資源無法載入:
foobar.com
的 NEL 收集器已收到通知example.com
的 NEL 收集器未收到通知
根據經驗法則,NEL 會重現剛剛在用戶端產生的伺服器端記錄。
由於 example.com
無法查看 foobar.com
的伺服器記錄,因此也無法查看其 NEL 報表。
對報表設定進行偵錯
如果伺服器未顯示報表,請前往 chrome://net-export/
。若要確認內容設定是否正確以及系統正確傳送報表,此頁面非常實用。
ReportingObserver 呢?
「ReportingObserver
」是具有相關但但檢舉機制不同的內容。其以 JavaScript 呼叫為基礎。不適合記錄網路錯誤記錄,因為網路錯誤無法透過 JavaScript 攔截。
範例伺服器
以下是使用 Express 的節點伺服器範例。說明如何設定網路錯誤的報告,並建立專用的處理常式來擷取結果。
const express = require('express');
const app = express();
app.use(
express.json({
type: ['application/json', 'application/reports+json'],
}),
);
app.use(express.urlencoded());
app.get('/', (request, response) => {
// Note: report_to and not report-to for NEL.
response.set('NEL', `{"report_to": "network-errors", "max_age": 2592000}`);
// The Report-To header tells the browser where to send network errors.
// The default group (first example below) captures interventions and
// deprecation reports. Other groups, like the network-error group, are referenced by their "group" name.
response.set(
'Report-To',
`{
"max_age": 2592000,
"endpoints": [{
"url": "https://reporting-observer-api-demo.glitch.me/reports"
}],
}, {
"group": "network-errors",
"max_age": 2592000,
"endpoints": [{
"url": "https://reporting-observer-api-demo.glitch.me/network-reports"
}]
}`,
);
response.sendFile('./index.html');
});
function echoReports(request, response) {
// Record report in server logs or otherwise process results.
for (const report of request.body) {
console.log(report.body);
}
response.send(request.body);
}
app.post('/network-reports', (request, response) => {
console.log(`${request.body.length} Network error reports:`);
echoReports(request, response);
});
const listener = app.listen(process.env.PORT, () => {
console.log(`Your app is listening on port ${listener.address().port}`);
});
其他資訊
- 使用 Reporting API 監控網路應用程式 (位於 Reporting API 的主要文章)
- 從 Reporting API v0 遷移至 v1 的指南
- 規格:舊版 Reporting API (v0)
- 規格:新 Reporting API (v1)