ネットワーク エラー ロギング（NEL）

Eric Bidelman

Maud Nalpas

はじめに

ネットワーク エラー ロギング（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"
    }]
}

エンドポイント URL がサイトとは異なるオリジンにある場合、エンドポイントで 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）。

この例では、このレスポンス ヘッダーをメインページとともに送信すると、ブラウザで生成された警告が max_age 秒間エンドポイント https://analytics.provider.com/browser-errors に報告されるようにブラウザが構成されます。そのページで行われた後続の HTTP リクエスト（画像やスクリプトなど）はすべて無視されることに注意してください。構成はメインページのレスポンス時に設定されます。

ヘッダー フィールドの説明

各エンドポイント構成には、group 名、max_age、endpoints 配列が含まれています。また、include_subdomains フィールドを使用して、エラーを報告する際にサブドメインを考慮するかどうかを選択することもできます。

group 名は、文字列をエンドポイントに関連付けるために使用される一意の名前です。Reporting API と統合される他の場所でこの名前を使用して、特定のエンドポイント グループを参照します。

max-age フィールドも必須です。ブラウザがエンドポイントを使用してエラーを報告する期間を指定します。

endpoints フィールドは、フェイルオーバーとロード バランシング機能を提供するための配列です。フェイルオーバーとロード バランシングのセクションをご覧ください。グループが endpoints に複数のコレクタをリストしている場合でも、ブラウザは 1 つのエンドポイントのみを選択することに注意してください。レポートを一度に複数のサーバーに送信する場合は、バックエンドでレポートを転送する必要があります。

ブラウザはどのようにレポートを送信しますか？

ブラウザはレポートを定期的にバッチ処理し、構成したレポート エンドポイントに送信します。

レポートを送信するために、ブラウザは Content-Type: application/reports+json と、キャプチャされた警告/エラーの配列を含む本文を指定して POST リクエストを発行します。

ブラウザはいつレポートを送信しますか？

レポートはアプリから帯域外で配信されます。つまり、レポートがサーバーに送信されるタイミングはブラウザが制御します。

ブラウザは、キューに入れられたレポートを適切なタイミングで配信しようとします。これは、デベロッパーにフィードバックをタイムリーに提供するため、準備が整い次第すぐに行われることもありますが、優先度の高い作業の処理でビジー状態となる場合や、ユーザーが使用しているネットワークが低速または混雑している場合は、配信を遅らせることもあります。また、ユーザーが頻繁にアクセスしている場合、ブラウザは特定のオリジンに関するレポートを優先的に送信することがあります。

Reporting API を使用する際、パフォーマンス上の問題（アプリとのネットワーク競合など）はほとんど、あるいはまったくありません。また、キューに入れられたレポートをブラウザから送信するタイミングを制御する手段もありません。

複数のエンドポイントの構成

複数の Report-To ヘッダーを送信することで、1 つのレスポンスで複数のエンドポイントを一度に構成できます。

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 値に従ってエンドポイントをキャッシュに保存し、コンソールで悪質な警告やエラーをすべて URL に送信します。

フェイルオーバーとロード バランシング

ほとんどの場合、グループごとに 1 つの URL コレクタを構成します。ただし、レポートでは大量のトラフィックを生成できるため、仕様には DNS SRV レコードに基づくフェイルオーバーとロード バランシングの機能が含まれています。

ブラウザは、グループ内の最大 1 つのエンドポイントにレポートを配信するように最善を尽くします。エンドポイントには 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 はオリジンに対してオプトインされるため、ヘッダーを送信する必要があるのは 1 回だけです。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）