Ghi nhật ký lỗi mạng (NEL)

Maud Nalpas
Maud Nalpas
X GitHub

Giới thiệu

Ghi nhật ký lỗi mạng (NEL) là một cơ chế để thu thập lỗi mạng phía máy khách từ một nguồn gốc.

API này sử dụng tiêu đề phản hồi HTTP NEL để yêu cầu trình duyệt thu thập lỗi mạng, sau đó tích hợp với API Báo cáo để báo cáo lỗi cho máy chủ.

Tổng quan về API Báo cáo cũ

Để sử dụng API Báo cáo cũ, bạn cần đặt tiêu đề phản hồi HTTP Report-To. Giá trị của lớp này là một đối tượng mô tả một nhóm điểm cuối để trình duyệt báo cáo lỗi:

Report-To:
{
    "max_age": 10886400,
    "endpoints": [{
    "url": "https://analytics.provider.com/browser-errors"
    }]
}

Nếu URL điểm cuối của bạn nằm trên một nguồn gốc khác với trang web, thì điểm cuối đó phải hỗ trợ các yêu cầu kiểm tra CORS. (ví dụ: 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).

Trong ví dụ, việc gửi tiêu đề phản hồi này với trang chính của bạn sẽ định cấu hình trình duyệt để báo cáo các cảnh báo do trình duyệt tạo cho điểm cuối https://analytics.provider.com/browser-errors trong max_age giây. Điều quan trọng cần lưu ý là tất cả các yêu cầu HTTP tiếp theo do trang thực hiện (đối với hình ảnh, tập lệnh, v.v.) sẽ bị bỏ qua. Cấu hình được thiết lập trong quá trình phản hồi của trang chính.

Giải thích về trường tiêu đề

Mỗi cấu hình điểm cuối chứa một tên group, max_age và mảng endpoints. Bạn cũng có thể chọn xem có xem xét các miền con khi báo cáo lỗi hay không bằng cách sử dụng trường include_subdomains.

Kỹ thuật Loại Nội dung mô tả
group string Không bắt buộc. Nếu bạn không chỉ định tên group, thì điểm cuối sẽ được đặt tên là "default".
max_age number Bắt buộc. Một số nguyên không âm xác định thời gian tồn tại của điểm cuối tính bằng giây. Giá trị "0" sẽ khiến nhóm điểm cuối bị xoá khỏi bộ nhớ đệm báo cáo của tác nhân người dùng.
endpoints Mảng<Object> Bắt buộc. Một mảng các đối tượng JSON chỉ định URL thực tế của trình thu thập báo cáo.
include_subdomains boolean Không bắt buộc. Giá trị boolean bật nhóm điểm cuối cho tất cả miền con của máy chủ lưu trữ gốc hiện tại. Nếu bị bỏ qua hoặc có giá trị khác với giá trị "true", thì các miền con sẽ không được báo cáo cho điểm cuối.

Tên group là tên riêng biệt dùng để liên kết một chuỗi với một điểm cuối. Hãy dùng tên này ở các vị trí khác tích hợp với API Báo cáo để tham chiếu đến một nhóm thiết bị đầu cuối cụ thể.

Trường max-age cũng là trường bắt buộc và chỉ định thời gian trình duyệt sẽ sử dụng điểm cuối và báo cáo lỗi cho điểm cuối đó.

Trường endpoints là một mảng để cung cấp các tính năng chuyển đổi dự phòng và cân bằng tải. Hãy xem phần Chuyển đổi cơ chế và cân bằng tải. Điều quan trọng cần lưu ý là trình duyệt sẽ chỉ chọn một điểm cuối, ngay cả khi nhóm liệt kê nhiều trình thu thập trong endpoints. Nếu bạn muốn gửi một báo cáo đến nhiều máy chủ cùng một lúc, thì phần phụ trợ của bạn sẽ cần chuyển tiếp các báo cáo đó.

Trình duyệt gửi báo cáo như thế nào?

Trình duyệt định kỳ báo cáo theo lô và gửi đến các điểm cuối báo cáo mà bạn định cấu hình.

Để gửi báo cáo, trình duyệt sẽ đưa ra yêu cầu POST với Content-Type: application/reports+json và một nội dung chứa mảng cảnh báo/lỗi đã được thu thập.

Khi nào trình duyệt gửi báo cáo?

Báo cáo được phân phối ngoài băng tần từ ứng dụng của bạn, nghĩa là trình duyệt sẽ kiểm soát thời điểm các báo cáo được gửi đến(các) máy chủ của bạn.

Trình duyệt sẽ cố gắng phân phối các báo cáo trong hàng đợi tại thời điểm thích hợp nhất. Quá trình này có thể ngay khi sẵn sàng (để cung cấp phản hồi kịp thời cho nhà phát triển) nhưng trình duyệt cũng có thể trì hoãn việc phân phối nếu đang bận xử lý công việc có mức độ ưu tiên cao hơn hoặc nếu người dùng tại thời điểm đó đang sử dụng mạng chậm và/hoặc bị nghẽn. Trình duyệt cũng có thể ưu tiên gửi trước các báo cáo về một nguồn gốc cụ thể, nếu người dùng là khách truy cập thường xuyên.

Hầu như không phải lo ngại về hiệu suất (ví dụ: tranh chấp về mạng với ứng dụng) khi sử dụng API Báo cáo. Ngoài ra, cũng không có cách nào để kiểm soát thời điểm trình duyệt gửi báo cáo trong hàng đợi.

Định cấu hình nhiều điểm cuối

Một phản hồi có thể định cấu hình nhiều điểm cuối cùng lúc bằng cách gửi nhiều tiêu đề 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"
             }]
           }

hoặc bằng cách kết hợp chúng vào một tiêu đề HTTP duy nhất:

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"
             }]
           }

Sau khi bạn gửi tiêu đề Report-To, trình duyệt sẽ lưu các điểm cuối vào bộ nhớ đệm theo giá trị max_age, rồi gửi tất cả các cảnh báo/lỗi khó chịu đó trên bảng điều khiển đến URL của bạn.

Chuyển đổi dự phòng và cân bằng tải

Trong hầu hết trường hợp, bạn sẽ định cấu hình một trình thu thập URL cho mỗi nhóm. Tuy nhiên, vì báo cáo có thể tạo ra một lượng lớn lưu lượng truy cập, nên thông số kỹ thuật bao gồm các tính năng chuyển đổi dự phòng và cân bằng tải lấy cảm hứng từ bản ghi SRV DNS.

Trình duyệt sẽ cố gắng hết sức để gửi báo cáo cho tối đa một điểm cuối trong nhóm. Các điểm cuối có thể được chỉ định một weight để phân phối tải, trong đó mỗi điểm cuối nhận được một tỷ lệ lưu lượng truy cập báo cáo được chỉ định. Các điểm cuối cũng có thể được chỉ định một priority để thiết lập bộ thu thập dự phòng.

Trình thu thập dự phòng chỉ được thử khi không tải được trình thu thập chính lên.

Ví dụ: Tạo trình thu thập dự phòng tại 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}
             ]
           }

Thiết lập tính năng ghi nhật ký lỗi mạng

Thiết lập

Để sử dụng NEL, hãy thiết lập tiêu đề Report-To với bộ thu thập sử dụng nhóm được đặt tên:

Report-To: {
    ...
  }, {
    "group": "network-errors",
    "max_age": 2592000,
    "endpoints": [{
      "url": "https://analytics.provider.com/networkerrors"
    }]
  }

Tiếp theo, hãy gửi tiêu đề phản hồi NEL để bắt đầu thu thập thông tin về lỗi. Vì NEL chọn sử dụng cho một máy chủ gốc, nên bạn chỉ cần gửi tiêu đề một lần. Cả NEL và Report-To đều sẽ áp dụng cho các yêu cầu trong tương lai đến cùng một nguồn gốc và sẽ tiếp tục thu thập lỗi theo giá trị max_age dùng để thiết lập trình thu thập.

Giá trị tiêu đề phải là một đối tượng JSON có chứa trường max_age và report_to. Sử dụng tên sau để tham chiếu tên nhóm của trình thu thập lỗi mạng:

GET /index.html HTTP/1.1
NEL: {"report_to": "network-errors", "max_age": 2592000}

Tài nguyên phụ

Ví dụ: Nếu example.com tải foobar.com/cat.gif và tài nguyên đó không tải được:

  • Trình thu thập NEL của foobar.com đã được thông báo
  • Trình thu thập NEL của example.com không được thông báo

Quy tắc chung là NEL tái tạo nhật ký phía máy chủ, vừa được tạo trên máy khách.

Vì example.com không xem được nhật ký máy chủ của foobar.com, nên nó cũng không xem được các báo cáo NEL của nó.

Gỡ lỗi cấu hình báo cáo

Nếu bạn không thấy báo cáo xuất hiện trên máy chủ của mình, hãy truy cập vào chrome://net-export/. Trang đó rất hữu ích trong việc xác minh mọi thứ được định cấu hình chính xác và các báo cáo đang được gửi đúng cách.

Còn ReportingNgười quan sát báo cáo thì sao?

ReportingObserver là một cơ chế báo cáo có liên quan nhưng khác. API này dựa trên các lệnh gọi JavaScript. Công cụ này không phù hợp để ghi nhật ký lỗi mạng vì không thể chặn lỗi mạng thông qua JavaScript.

Máy chủ mẫu

Dưới đây là ví dụ về máy chủ Nút sử dụng Express. Tài liệu này trình bày cách định cấu hình tính năng báo cáo cho các lỗi mạng và tạo một trình xử lý chuyên dụng để nắm bắt kết quả.

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}`);
});

Tài liệu đọc thêm