バグ報告のたびに記録される、Chrome のネットワークログ
更新日
Midge は、すべてのバグ報告に Chrome のネットワークログを自動で記録します。fetch と XHR のリクエストはヘッダー、リクエストとレスポンスのボディ、ステータスコード、タイミング付きで、WebSocket のメッセージは送受信のたびに記録されます。スクリプト、スタイル、画像、フォントは、ステータス、サイズ、タイミングとともに一覧に並びます。開発者はどのリクエストも開いて中身を見られ、cURL としてコピーしたり、ログ全体を伏せ字済みの HAR ファイルとしてダウンロードしたりできます。
DevTools を開いておく必要はなく、バグを報告する人が HAR ファイルとは何かを知っている必要もありません。すべての録画に、コンソールログ、ネットワークリクエスト、ユーザー操作、デバイス情報が含まれます。
DevTools のネットワークパネルだけでは足りない理由
Chrome のネットワークパネルは、自分でデバッグするときには非常に優秀です。しかしバグ報告に使うとなると、3 つの問題があります。
- リクエストが発生する前に開いておく必要があります。 DevTools を開く前に発生したリクエストは残っておらず、たいていの人はバグが起きてから開きます。
- ページを移動すると消えます。 誰かが「Preserve log」にチェックを入れるのを覚えていない限りです。
- HAR のエクスポートには機密情報が含まれます。 Cookie、
Authorizationヘッダー、クエリ文字列内のトークンがすべてファイルに入ってしまいます。それがなぜ問題なのかは、「HAR ファイルから機密データを削除する方法」で説明しています。
Midge は各ページでバックグラウンドでネットワークの動きを記録し、直近のリクエストをメモリ上に保持して、レポートを作成するときに添付します。機密情報はアップロード前に取り除かれます。
レポートでのリクエストの見え方
各リクエストは、動画やコンソールと同じタイムライン上に配置されます。1 つ開くと、やり取りの全体が見られます。
POST /api/v2/invoices HTTP/1.1
Content-Type: application/json
Authorization: [REDACTED]
{"customerId": "cus_8812", "lines": [{"sku": "PRO-M", "qty": 3}]}
HTTP/1.1 409 Conflict
Content-Type: application/json
{"error": "invoice_already_open", "invoiceId": "inv_3021"}
ボディに加えて、ステータスコード、所要時間、リクエストの開始時刻もわかります。リクエストは動画の横に時刻順で並ぶため、上の 409 は何十件もの画像読み込みに埋もれることなく、それを引き起こしたクリックのすぐ後ろに表示されます。
WebSocket のメッセージ
リアルタイムアプリの不具合は、HTTP ではなくソケットで起きることがよくあります。Midge は WebSocket のメッセージを双方向ともタイムスタンプ付きで記録するので、サーバーが {"type":"price_update"} を 2 回送ったのに、クライアントが 1 回目しか描画しなかった、といったことがわかります。
その他のリソース
スクリプト、スタイルシート、画像、フォント、ドキュメントは、ボディなしでステータスコード、サイズ、タイミングとともに一覧に並びます。たいていはそれで十分です。デプロイ後に app.4f2c1.js が 404 になっている、3 MB のヒーロー画像が最初の描画を遅らせている、といったことがわかります。
GraphQL もきちんと扱う
GraphQL を使うと、ネットワークログは読みにくくなります。すべてのリクエストが同じ /graphql エンドポイントに送られ、エラーも HTTP 200 で返ってくることがよくあるからです。
{
"data": { "updateProfile": null },
"errors": [{ "message": "Not authorized to update this profile", "path": ["updateProfile"] }]
}
Midge は GraphQL リクエストごとに UpdateProfile のようなオペレーション名を表示し、errors 配列を含む 200 のレスポンスにフラグを立てます。ステータスコードでの絞り込みでは隠れてしまう失敗も、失敗として表示されます。
cURL としてコピー
記録したリクエストはどれも cURL コマンドとしてコピーできるので、バックエンドの開発者はターミナルから再送して、同じレスポンスを確認できます。マスキングが先に行われるため、Authorization ヘッダーと Cookie は [REDACTED] になっています。自分のテストアカウントのトークンに差し替えて実行してください。これは意図的な設計です。バグ報告が、有効なセッションを配ってしまうことがあってはなりません。
伏せ字済みの HAR をエクスポート
HAR ファイルを求めるチームや取引先もあります。Midge ではレポートのネットワークログを HAR としてダウンロードでき、ファイルには伏せ字済みのデータが入っています。無料の HAR ビューアで開くことも、キーを漏らさずに API 提供元へのサポートチケットに添付することもできます。DevTools から直接エクスポートした HAR がある場合は、拡張機能と同じルールを使う HAR サニタイザーできれいにしてください。
伏せられる情報
パスワード、カード番号、トークン、Cookie は、デバイスから送信される前にブラウザ内で伏せられます。ネットワークデータでは、具体的には次のとおりです。
Authorization、Cookie、Set-Cookie、API キーや CSRF のヘッダー、そして名前に token、secret、session、auth などの単語を含むヘッダー。access_token、code、api_key、signatureなどの機密性のある URL パラメータ。password、otp、cvv、iban、card_numberなどのボディのフィールド(ネストされたものも含む)。- ペイロード内のどこにあっても、JWT、Luhn チェックを通るカード番号、既知の形式の API キー。
メールアドレスと国際電話番号は一部だけマスクされます。全一覧はマスキングのページにあります。
制限事項
リクエストとレスポンスのボディが記録されるのは fetch、XHR、WebSocket で、その他のリソースはメタデータのみの表示です。Chrome 以外のアプリの通信はレポートに含まれず、記録しないサイトのリストに追加したサイトでは Midge は動作しません。一度きりの調査でブラウザレベルの完全な記録が必要な場合は、「Chrome でネットワーク通信を記録する方法」で DevTools を使う方法を説明しています。
Midge は無料で、録画数は無制限、動画は最長 15 分、透かしも入りません。
よくある質問
- Midge はどのリクエストを記録しますか?
- fetch と XHR のリクエストを、ヘッダー、リクエストとレスポンスのボディ、ステータスコード、タイミング付きで記録し、WebSocket のメッセージも記録します。スクリプト、スタイルシート、画像、フォント、ドキュメントなどのその他のリソースは、ステータス、サイズ、タイミングとともに一覧に並びます。
- ネットワークログを HAR ファイルとしてエクスポートできますか?
- はい。レポートのネットワークログは HAR ファイルとしてダウンロードでき、ダウンロードされるのは生の値ではなく、伏せ字済みのデータです。
- Midge は GraphQL をどう扱いますか?
- GraphQL リクエストごとにオペレーション名を表示し、HTTP 200 を返しつつ errors 配列を含むレスポンスにフラグを立てます。ステータスコードでの絞り込みでは見落とされるものです。
- cURL としてコピーすると、認証トークンも含まれますか?
- いいえ。Authorization ヘッダーと Cookie はアップロード前に伏せられるので、コピーしたコマンドではその部分が [REDACTED] になっています。実行するときは自分のトークンを入れてください。