エラーログを共有する前に|認証情報を出さずに状況を伝える

エラーの調査では、ログをそのまま全文貼り付ける前に、含まれている情報を確認します。調査に必要な手がかりを残しながら、認証情報や個人情報を不必要に広げないための整理です。

必要な情報を選ぶ

どの操作で、どの段階に、どの応答が出たかをまとめます。秘密の値そのものより、変数が設定されているか、どの権限が必要かなどを確認するほうが適切な場合があります。値を見せなければ調査できないと決めつけません。

共有前の確認表

種類 扱いを確認すること
認証情報 キー・パスワード・認証ヘッダー
接続先 非公開の場所や機密の識別子
本文 個人情報や未公開資料
応答 内部情報が含まれていないか
周辺ログ 別の処理の情報が混ざっていないか

「一部が自動で隠れる」ことを、全情報が安全に加工された保証として扱いません。実際に共有する文字列を確認します。

安全な説明の型

[対象操作]を実行したところ、[段階]で停止しました。
状態コードは[値]、エラーの要旨は[秘密を除いた説明]です。
[確認した設定項目]は確認済みで、[未確認事項]が残っています。

架空の型です。エラー文を要約した場合は、原文ではなく要旨と分かる形にします。原因が確定していなければ断定しません。

画像で共有する場合

画面上の変数名だけでなく、その右側の値、アドレス欄、別のタブや通知も確認します。ログの一部を隠した後、元画像を取り違えて送らないようにします。公開先と必要な閲覧範囲も考えます。

秘密を出してしまった可能性があるとき

単に投稿を消したことだけで安全と判断せず、扱っている認証情報の停止・変更手順を確認します。実際に無効化したかを確認する前に、対応完了と報告しません。

設定の有無を伝える例

架空の例として、「必要な変数は設定されているが、今回の実行で利用できる範囲は未確認」と説明できます。設定画面に項目があることと、処理から読めることを分けます。値の全文を貼る代わりに、変数名、設定された場所、対象の実行条件など、秘密を含まない情報から調べます。

関連する確認

認証情報の利用範囲と初回の自動操作の確認も参考になります。

コメント

タイトルとURLをコピーしました