FIELD NOTES FOR AI-ERA DEVELOPERS

AI開発メモ

「AIを使え」に、現場の地に足ついた一歩で応える開発メディア

無料ツール|印刷用チェックリスト

AIにログ出力の不足を指摘させるチェックリスト

全部に○が要るわけではありません。**気になった行だけ**で十分です。

① たどる

  • 入口で相関ID(リクエストID)を発番しているか
  • その値が、ログのすべての行に載っているか
  • 非同期処理・キュー・ジョブの先まで引き継がれているか
  • 外部サービスの呼び出しでも受け渡しているか
  • エラー画面や応答に、問い合わせ用として出しているか
  • 1件を実際に検索して、入口から出口まで並ぶことを確かめたか

② わかる

  • 1行に入れる項目(時刻・相関ID・対象・処理名・結果・所要時間)を決めたか
  • 時刻がタイムゾーンの分かる形で統一されているか
  • 機械が読める形(構造化ログ)になっているか
  • 失敗したときに、入力の要約と外部の応答が残るか
  • 例外をオブジェクトごと渡して、スタックトレースが残っているか
  • 同じ例外を複数の層で重ねて出していないか
  • 早期リターンや条件で弾いた箇所にも、理由が残るか
  • ログレベルの意味をチームで決めたか
  • ループの中で1件ずつ出さず、まとめて出しているか

③ 出さない

  • 出してはいけない情報を、具体名で列挙したか
  • リクエスト・レスポンスの全文を出していないか
  • マスク処理を共通の場所に寄せたか
  • 保持期間を決めたか
  • 本番ログの閲覧権限を決めたか
  • AIにログを貼る前に、個人情報と鍵を落とす手順があるか

この内容は記事「AIにログ出力の不足を指摘させる|障害調査で困らない設計」のチェックリストです。印刷してそのままお使いいただけます。 / 無料ツール一覧へ