録画ボタンを押す前のエラーまで残る、コンソールログ付きの画面録画
更新日
Midge は、コンソールログ付きの画面録画ツールです。Chrome で画面を録画したりスクリーンショットを撮ったりしている間、console.log からキャッチされなかった例外、処理されなかった Promise の reject まで、ページが出力するすべてのコンソールメッセージをスタックトレース付きで記録し、動画と時刻をそろえて並べます。Midge は直近のコンソール出力を常にバッファしているので、録画ボタンを押す前に発生したエラーもレポートに残ります。
多くのバグ報告に欠けているのは、この 2 つ目の部分です。何かが壊れたと気づいたときには、エラーは誰も開いていなかった DevTools の画面の中で、とっくに流れ去っています。Midge があれば、「コンソールを開いた状態でもう一度再現してもらえますか?」という手間はなくなります。
記録される内容
すべてのコンソールレベル
Midge は log、info、warn、error、debug の呼び出しを、タイムスタンプと渡された値とともに記録します。警告は思っている以上に重要です。クラッシュ直前に出力された React の key に関する警告や非推奨の通知が、本当の手がかりであることはよくあります。
キャッチされなかったエラー
誰にもキャッチされなかった例外は console.error を通りません。window まで伝わり、ブラウザが赤字で表示します。Midge はこれも監視しているので、アプリにログ出力の仕組みがまったくなくても、イベントハンドラー内のクラッシュはちゃんと記録されます。
処理されなかった Promise の reject
.catch() のない Promise の reject は、最近のフロントエンドで最もよくある「静かな失敗」の 1 つです。fetch が reject されたのに誰も処理していなかったせいで、ボタンが「何も反応しない」のです。Midge はこうした reject と、その理由を記録します。
スタックトレース
エラーについては、ブラウザが報告したスタックトレースを保存します。典型的なエントリはこのようになります。
Uncaught (in promise) TypeError: Failed to fetch
at submitOrder (orders.js:88:15)
at HTMLButtonElement.onClick (checkout.js:41:9)
本番のバンドルが minify されている場合、スタックにはブラウザが報告したとおりの minify 後のファイル名と位置が表示されます。本番環境からのレポートを読むときは、ソースマップを手元に用意しておきましょう。
録画ボタンを押す前から記録
Midge は各ページの読み込みが始まった時点、つまりアプリ自身のスクリプトが動き出す前から監視を始めます。そのため、起動中に投げられたエラーも捕まえられます。開いているすべてのタブについて、直近数分間のコンソール出力をメモリ上に保持しています。
画面録画を始めたりスクリーンショットを撮ったりすると、この直近の履歴が添付されます。実際には、普段どおり作業していて、何かおかしいと気づいてから報告するかどうかを決めればよい、ということです。20 秒前の赤いエラーも、ちゃんとタイムラインに残っています。
バッファについて、いくつか補足します。
- メモリ上にだけ置かれ、タブを閉じると消去されます。
- レポートを作成しない限り、パソコンの外には何も出ません。
- 通常の http と https のページで動作します。銀行やパスワードマネージャーなど、Midge を絶対に動かしたくないサイトを追加できます。
コンソールと動画を 1 つのタイムラインに
すべての録画に、コンソールログ、ネットワークリクエスト、ユーザー操作、デバイス情報が含まれます。レポートでは、コンソールが動画の横に時刻順で並びます。モーダルが開かなかった瞬間を見れば、対応する TypeError が、それを引き起こしたクリックの数行下にすぐ見つかります。
エラーはネットワークの動きと組み合わせると、ぐっと読みやすくなります。/api/orders からの 500 に続いて Cannot read properties of undefined が出ていれば、それだけで全体像がわかります。サーバーが失敗し、クライアントがその失敗を処理できなかったのです。詳しくはネットワークログのページをご覧ください。
コンソール出力内の機密情報
開発者は、特にデバッグ中に、本来ログに出すべきでないものを出してしまいがちです。トークン、ユーザーオブジェクト丸ごと、クエリ文字列に API キーが入ったリクエスト URL などです。Midge は、ネットワークデータに使うのと同じマスキングルールをコンソールのテキストにも適用します。パスワード、カード番号、トークン、Cookie は、デバイスから送信される前にブラウザ内で伏せられます。
たとえば、次の行は
auth ok: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0MiJ9.abc123 for [email protected]
レポートでは次のように表示されます。
auth ok: [REDACTED] for j***@acme.com
ルールの全一覧と、マスキングで捕まえられないものについては、マスキングのページをご覧ください。
Midge と、手作業でのコンソールのエクスポートの違い
Chrome の DevTools からコンソール出力を自分で保存することもできます。手順は「Chrome でコンソールログをエクスポートする方法」で説明しています。この方法でも使えますが、抜けがあります。エラーが起きる前に DevTools を開いておく必要があり、エクスポートされるのは動画のないプレーンテキストで、機密情報を取り除く仕組みもありません。ログや HAR ファイルを手作業でエクスポートする場合は、チケットに添付する前に無料の HAR サニタイザーに通してください。
Midge なら、DevTools を開いていたかどうかに関係なくコンソールが記録され、あなたが見ていた画面と同期し、アップロード前に機密情報が伏せられます。
このログを読むのは誰か
QA テスターは、途中で切れたスタックトレースをチケットに貼り付ける必要がなくなります。サポート担当者は、コンソールが何かを知らなくても、本物のエラー出力をエスカレーションに添付できます。開発者は、正確なエラー、スタック、その前後のネットワーク通信を 1 か所で受け取れます。あなたが開発者なら、開発者向けの Midge もご覧ください。
Midge は無料で、録画数は無制限、動画は最長 15 分、透かしも入りません。
よくある質問
- Midge はどのコンソールメッセージを記録しますか?
- log、info、warn、error、debug の 5 つのレベルすべてです。さらに、console.error を通らないキャッチされなかった例外や、処理されなかった Promise の reject も、スタックトレース付きで記録します。
- 録画を始める前に起きたエラーも記録できますか?
- はい。Midge はタブごとに直近数分間のコンソール出力をメモリ上に保持しているので、エラー直後に作った録画やスクリーンショットにもそのエラーが含まれます。このバッファはタブを閉じると消去され、レポートを作成しない限りデバイスの外には出ません。
- コンソールメッセージ内の機密情報は伏せられますか?
- はい。JWT、カード番号、既知の形式の API キー、秘密鍵、機密性のある URL パラメータはコンソールのテキストから取り除かれ、メールアドレスと国際電話番号は一部だけマスクされます。
- DevTools を開いておく必要はありますか?
- いいえ。Midge は DevTools を開いていなくてもコンソールを記録し、レポートを開いた人は動画の横でメッセージを確認できます。