仕様書の疑問シリーズ〜ログってどれくらい取ればいいの？〜

システム開発ではよく出てくる「ログを取っておいてください」。
でも、実際に仕様書に落とし込む段階でよく悩むのが、「どこまでログを取ればいいのか？」ということです。

取りすぎても困る、足りなくても困る

ログは多ければいい、というものでもありません。
・多すぎると：保存容量が逼迫／探すのが大変／個人情報のリスク
・少なすぎると：トラブルの原因が追えない／調査に時間がかかる

だからこそ、目的に応じてログの「粒度」と「内容」を設計することが大切です。

押さえておきたいログのポイント

たとえば以下のような内容は、ログに残しておくと安心です。
・誰が・いつ・何をしたか（操作ログ）
・システムで何が起きたか（処理ログ・エラーログ）
・外部連携の結果（成功・失敗・レスポンス内容）

そして、どのログをどこまで残すかは、お客様と合意をとっておくべきポイントでもあります。

最後に

ログは“トラブル時の保険”のようなもの。
普段は意識されにくいですが、いざという時に「ログがある／ない」で雲泥の差が出ます。

なので、仕様書に書く際は、
「何のために」「誰のために」「いつ見るか」を意識した設計が重要です。