ログ仕様の方式設計書に記載すべき内容

Question

ログ仕様の方式設計書にどのような内容について記載すればよろしいでしょうか？

Answer 1

ざっと思いつくだけで下記のような感じでしょうか。

• ログのフォーマット（必要な情報（日時：ログレベル：内容・・・とか）とあとで調査しやすい形式を考える）
• ログレベル（INFOやERRORなどのレベルを決める判断基準）
• ログ出力先（どのディレクトリに出すのか、複数のファイルに出しわける、そもそも他のサーバーに送るとか）
• ログローテーションの方針（ログファイルの容量だったり、一定の期間だったりでローテーションするとか）
• ログ削除やバックアップの方針（ずっと取っておくのかどっかに一定の条件で削除していいのか）

ログはあってもgrepしにくくて調査ができないとか、容量がパンパンになってしまったけどどうしようとか、かなり後の方になって困ることが多いのでその辺を見据えて設計ができるといいですね。

Answer 2

適当にググって開発チームに合うものを探してみてはどうでしょうか。

例えばこういう例。
ソフトウェア開発標準サンプル @ wiki - 方式設計サンプル