Reporting API v1 に移行する

新しいバージョンの Reporting API をご利用いただけます。よりプライバシーが保護され、ブラウザ間でサポートされる可能性が高い。

Maud Nalpas

Reporting API は、訪問者がサイトを使用する際に発生したエラーを通知します。ブラウザの介入、ブラウザのクラッシュ、Content-Security-Policy 違反、COOP / COEP 違反、非推奨に関する警告などを可視化できます。

Reporting API の新しいバージョンが利用可能になりました。新しい API はよりシンプルで、ブラウザ間でサポートされる可能性が高い。

概要

サイト デベロッパー

サイトにすでにレポート機能がある場合: 新しいヘッダー（Reporting-Endpoints）を使用して v1 に移行しますが、レガシー ヘッダーはしばらくそのままにしておきます（Report-To）。移行: コード例をご覧ください。

今すぐサイトにレポート機能を追加する場合: 新しいヘッダー（Reporting-Endpoints）のみを使用します。

⚠️ どちらの場合も、レポートを生成する可能性があるすべてのレスポンスに Reporting-Endpoints ヘッダーを設定してください。

レポート サービスのデベロッパー

エンドポイント サービスを管理している場合や独自のエンドポイント サービスを運用している場合、ご自身または外部のデベロッパーが Reporting API v1（Reporting-Endpoints ヘッダー）に移行するため、トラフィックの増加が予想されます。

詳細とサンプルコードについては、以下をご覧ください。

ネットワーク エラーのロギング

ネットワーク エラーのロギングのための新しいメカニズムが開発されます。利用可能になったら、Reporting API v0 から新しいメカニズムに切り替えてください。

デモとコード

• デモサイト: 新しい Reporting API（v1）
• デモサイトのコード

v0 と v1 の違い

変更点

• API サーフェスは異なります。

 Report-To: { group: "main-endpoint", "max_age": 86400, "endpoints": [ { "url": ... }, { "url": ... }] }, { group: "default-endpoint", "max_age": 86400, "endpoints": [ { "url": ... }, { "url": ... }] }
 Document-Policy: ...; report-to main-endpoint

 Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"
 Document-Policy: ...; report-to main-endpoint

• レポートのスコープが異なります。

• どちらの API も同じレポートタイプをサポートしていますが、1 つの例外として、v1 ではネットワーク エラーレポートはサポートされていません。詳しくは、移行手順をご覧ください。
• v0 はサポートされておらず、複数のブラウザではサポートされません。v1 は今後複数のブラウザでサポートされる可能性があります。

これまでと変わらない点

• レポートの形式と構造は変更されません。
• ブラウザからエンドポイントに送信されるリクエストは、Content-type application/reports+json の POST リクエストのままになります。
• 特定のエンドポイントを特定のレポートタイプにマッピングすることは、v0 と v1 の両方でサポートされています。
• default エンドポイントのロールは変更されません。

• Reporting API v1 は ReportingObserver に影響しません。ReportingObserver は引き続きすべてのオブザーバブル レポートにアクセスでき、形式は同じです。

v0 と v1 のすべての違い

エンドポイント デベロッパー: トラフィックの増加が見込まれる

独自のサーバーをレポート エンドポイントとして設定している場合や、レポート コレクタをサービスとして開発またはメンテナンスしている場合は、そのエンドポイントへのトラフィックがさらに増加します。

これは、Reporting API v0 とは異なり、Reporting API v1 ではレポートがバッチ処理されないためです。したがって、アプリケーション デベロッパーが Reporting API v1 への移行を開始すると、レポートの数は変わらないものの、エンドポイント サーバーへのリクエスト数は増加します。

アプリケーション デベロッパー: Reporting-Endpoints（v1）に移行する

どうすればよいですか。

新しい Reporting API（v1）には、次のようなメリットがあります。

• ブラウザ シグナルはポジティブです。つまり、Chrome と Edge でのみサポートされている v0 とは異なり、v1 ではクロスブラウザのサポートが期待できます。
• API がシンプルになりました。
• 現在、新しい Reporting API（v1）を中心とするツールを開発中です。

これを踏まえると以下のようになります。

• サイトですでに Report-To ヘッダーを指定して Reporting API v0 を使用している場合は、Reporting API v1 に移行してください（移行手順をご覧ください）。サイトですでに Content-Security-Policy 違反のレポート機能を使用している場合は、CSP レポートの移行手順をご確認ください。
• サイトで Reporting API を使用しておらず、レポート機能を追加する場合は、新しい Reporting API（v1）（Reporting-Endpoints ヘッダー）を使用します。これには 1 つの例外があります。ネットワーク エラー ロギングを使用する必要がある場合は、Report-To（v0）を使用します。現在、Reporting API v1 ではネットワーク エラー ロギングはサポートされていません。ネットワーク エラーのロギング用の新しいメカニズムが開発されます。利用可能になるまでは、Reporting API v0 を使用してください。ネットワーク エラーロギングが他のレポートタイプと合わせて必要な場合は、Report-To（v0）と Reporting-Endpoints（v1）の両方を使用します。v0 ではネットワーク エラーロギング、v1 では他のすべてのレポートタイプになります。

移行手順

この移行の目標は、v0 で取得していたレポートが失われるのを防ぐことです。

1. ステップ 1（今すぐ行う）: Report-To（v0）と Reporting-Endpoints（v1）の両方のヘッダーを使用します。

   これにより、以下が得られます。

   • Reporting-Endpoints（v1）により、新しい Chrome クライアントと Edge クライアントからの報告。
   • Report-To（v0）により古い Chrome および Edge クライアントからレポートされたレポート。

   Reporting-Endpoints をサポートするブラウザ インスタンスは Reporting-Endpoints を使用し、サポートしていないインスタンスは Report-To にフォールバックします。リクエストとレポートの形式は、v0 と v1 で同じです。

2. ステップ 2（今すぐ実施）: レポートが生成される可能性があるすべてのレスポンスで Reporting-Endpoints ヘッダーが設定されていることを確認します。

   v0 では、一部のレスポンスにのみレポート エンドポイントを設定し、そのオリジンの他のドキュメント（ページ）はこの「アンビエント」エンドポイントを使用するように選択できます。v1 ではスコープが異なるため、レポートを生成するすべてのレスポンスに Reporting-Endpoints ヘッダーを設定する必要があります。

3. ステップ 3（後で開始）: すべてまたはほとんどのユーザーが、Chrome または Edge の今後のインストール（96 以降）に更新したら、Report-To（v0）を削除して Reporting-Endpoints のみを残します。

   1 つの例外: ネットワーク エラー ロギング レポートが必要な場合は、ネットワーク エラー ロギング用の新しいメカニズムが確立されるまで Report-To を保持します。

移行に関するクックブックのコード例をご覧ください。

CSP レポートの移行手順

Content-Security-Policy 違反レポートを構成する方法は 2 つあります。

• report-uri ディレクティブ経由の CSP ヘッダーのみ。これは、Chrome、Firefox、Safari、Edge など、幅広いブラウザでサポートされています。レポートは content-type application/csp-report で送信され、CSP に固有の形式になります。これらのレポートは「CSP レベル 2 レポート」と呼ばれ、Reporting API には依存しません。
• Reporting API では、Report-To ヘッダー（従来版）または新しい Reporting-Endpoints（v1）を使用します。これは Chrome と Edge でのみサポートされています。レポート リクエストの形式は、他の Reporting API リクエストと同じで、コンテンツ タイプは application/reports+json です。

最初の方法（report-uri のみ）の使用は推奨されなくなりました。2 つ目の方法にはいくつかのメリットがあります。特に、Reporting API を介して生成されるすべてのレポート リクエスト（CSP など）の形式が同じ application/reports+json であるため、すべてのレポート タイプのレポートを 1 つの方法で設定し、汎用エンドポイントを設定できます。

ただし、report-to をサポートしているのは一部ブラウザのみです。したがって、複数のブラウザから CSP 違反レポートを取得するには、Reporting API のアプローチ（Report-To 以上、Reporting-Endpoints）と一緒に report-uri を指定することをおすすめします。report-uri と report-to を認識するブラウザでは、report-to が存在する場合、report-uri は無視されます。report-uri のみを認識するブラウザでは、report-uri のみが考慮されます。

1. ステップ 1（今すぐ行う）: まだ追加していない場合は、report-uri と report-to を追加します。report-uri のみをサポートするブラウザ（Firefox）は report-uri を使用し、report-to もサポートするブラウザ（Chrome、Edge）は report-to を使用します。report-to で使用する名前付きエンドポイントを指定するには、ヘッダー Report-To と Reporting-Endpoints の両方を使用します。これにより、古い Chrome クライアントと新しい Chrome クライアント、古い Edge クライアントと新しい Edge クライアントの両方からレポートを受け取ることができます。

2. ステップ 3（後で開始）: すべてのユーザーまたはほとんどのユーザーが、新しいバージョンの Chrome または Edge（96 以降）に更新したら、Report-To（v0）を削除し、Reporting-Endpoints のみを残します。report-uri を保持すると、report-uri のみをサポートするブラウザのレポートも引き続き取得できます。

これらの手順のコード例については、CSP レポートの移行をご覧ください。

移行: コード例

概要

以前の Reporting API（v0）を使用して、COOP（Cross-Origin-Opener-Policy ヘッダー）、COEP（Cross-Origin-Embedder-Policy）、ドキュメント ポリシー（Document-Policy ヘッダー）の違反レポートを取得している場合: Reporting API v1 に移行する際に、これらのポリシー ヘッダー自体を変更する必要はありません。必要なのは、従来の Report-To ヘッダーから新しい Reporting-Endpoints ヘッダーに移行することです。

以前の Reporting API（v0）を使用して CSP（Content-Security-Policy ヘッダー）の違反レポートを取得している場合は、新しい Reporting API（v1）への移行の一環として Content-Security-Policy を調整する必要があります。

基本的な移行

Report-To: { group: "main-endpoint", "endpoints": [ { "url": "https://reports.example/main" }] }, { group: "default-endpoint", "endpoints": [ { "url": "https://reports.example/default" }] }

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"
Report-To: { group: "main-endpoint", "max_age": 86400, "endpoints": [ { "url": "https://reports.example/main" }] }, { group: "default-endpoint", "max_age": 86400, "endpoints": [ { "url": "https://reports.example/default" }] }

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"

v1 では、特定のレポートのタイプを特定のエンドポイントに送信することは引き続き可能です。ただし、エンドポイントごとに使用できる URL は 1 つだけです。

すべてのページをモニタリングする

app.get("/", (request, response) => {
  response.set("Report-To", …)
  response.render(...)
});
app.get("/page1", (request, response) => {
  response.render(...)
});

// Use a middleware to set the reporting endpoint(s) for *all* requests.
app.use(function(request, response, next) {
  response.set("Reporting-Endpoints", …);
  next();
});

app.get("/", (request, response) => {
  response.render(...)
});

app.get("/page1", (request, response) => {
  response.render(...)
});

CSP レポートの移行

Content-Security-Policy: ...; report-uri https://reports.example/main

Content-Security-Policy: ...; report-uri https://reports.example/main; report-to main-endpoint
Report-To: main-endpoint="https://reports.example/main"

Content-Security-Policy: ...; report-uri https://reports.example/main; report-to main-endpoint
Reporting-Endpoints: main-endpoint="https://reports.example/main"
Report-To: ...

関連情報

• Reporting API を使用してウェブ アプリケーションをモニタリングする（Reporting API に関するメイン投稿）
• 仕様: 以前の Reporting API（v0）
• 仕様: 新しい Reporting API（v1）

この記事のレビューと提案をしてくれた Ian Clelland 氏、Eiji Kitamura 氏、Milica Mihajlija 氏に感謝します。