システム開発において、ログ出力はとても重要です。エラーを検知することはもちろん、エラーが起こった原因の特定もログ出力で分かりやすくすることが出来ます。さらに、エラーを未然に防ぐためにログ出力することも出来ます。今回の記事では、ログ出力の適切な設置場所を考えます。
各ユーザー操作
ユーザー操作を逐一ログ出力したほうがいいです。操作ログなんて言われます。システムにおけるヒューマンエラーはよく起きるので、ユーザーがいつ何をしたのかはすべて記録に残すためです。
処理開始前
処理中にエラーが起きた際でもどこで落ちたか分かるように、処理の開始前にログ出力します。また、処理の開始前と終了後にログ出力することで、処理にどのくらい時間がかかったのかも把握することが出来ます。処理の単位（粒度）はテストの単位（粒度）が良いです。
異常終了未満の危険な挙動
異常終了まではいかないけども、このまま放置すると異常終了になるものには警告としてログ出力しましょう。また、何かおかしいな？とか想定と異なる挙動をした際には警告のログを出力しておくと、後で見返すときに何かと役立ちます。
処理が正常終了した後
正常に処理が行われたか確認するために、正常終了後にはログ出力します。また、処理の開始前と終了後にログ出力することで、処理にどのくらい時間がかかったのかも把握することが出来ます。
処理が異常終了した後
処理が異常終了した場合にログ出力します。以上終了の原因がわかればログに原因を記載するようにしましょう。
以上、「ログ出力の適切な設置場所について考える」でした。
