FIELD NOTES FOR SYSTEM MAINTAINERS

保守運用ノート

動いて当たり前のシステムを、ひとりで守る人のための実務メディア

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

改修時にログを仕込むチェックリスト

  • 処理の「入口」に、何の処理が何に対して始まったかを書いたか
  • 外部呼び出し(DB・API・メール・ファイル)の結果と時間を残したか
  • 受け止めた例外を、メッセージと発生場所つきで書いたか
  • ログを足すだけで、処理の流れ(例外を投げ直す・続行するなど)は変えていないか
  • 1行に処理名・対象のID・結果が入っているか
  • キー=値 の形で、検索しやすく書いたか
  • ERROR・WARN・INFO・DEBUGを基準どおりに使い分けたか
  • パスワード・トークン・個人情報を出力していないか
  • ループの中で大量の行を出していないか
  • 検証環境で出力先とローテーションの対象を確かめたか

全部できなくても大丈夫です。「例外を書いた」の1つだけでも、次の問い合わせのときにはっきり違いが出ます。

この内容は記事「改修時にログを仕込む|あとから原因を追えるログの残し方」のチェックリストです。印刷してそのままお使いいただけます。 / 無料ツール一覧へ