ログ出力のタイミングについて

Question

ログを出力するタイミングがいまいち分かりません。
try-catchのCatchの時やプログラムの起動時には出力していますが、例えば設定を読み込む際などには出力するのでしょうか？
今まではしていたのですが、設定を読み込むたびに同じログがいくつも出力されるので、これって必要か？と疑問に思いました。
また、ログに書き込む中身はどうしているのかも知りたいです。

よろしくお願いします。

Answer 1

複数人の開発だとコーディング規約で決定されていると思うので、一人で開発してると想定して回答します。
ログは主に、プログラムの実行を後から追跡するために使用します。

プログラムは
0. ユーザーが直接対話的に制御するプログラム
0. ユーザーが直接対話的に制御しないプログラムの2種類があります。

質問者さんが開発されているプログラムがどちらに該当するかによって、ログの出力粒度も変わってきます。

今まではしていたのですが、設定を読み込むたびに同じログがいくつも出力されるので、これって必要か？と疑問に思いました。

個人的な経験だと、設定ファイルが読み込まれたかどうかは出力することが多いです。
設定ファイルの設定値に関しては、同じ設定ファイルを複数回読まないように設定ファイルからDictionary or jsonに展開して、プログラム内部にインスタンスを保持する形にしてます。

質問者さんの問題としては「いくつも出力」されるとの事なので、気になる点はその設定値は本当にその型で必要なのかという点はありますが。

案1)ログの出力情報としてトレースレベルを追加する。
app.configにトレースレベルを追加して、出力を判断する。

案2)設定ファイルが読めなかった場合は例外をthrowしてユーザーに促す。
（初期設定値で設定ファイルを作成するなど）

---

また、ログに書き込む中身はどうしているのかも知りたいです。

最初にアプリケーションのバージョンとコマンドライン引数をログに書き込んだ後に
以下のメッセージ形式で出力することが多いです。

項目	内容
タイムスタンプ	ミリ秒単位
トレースレベル	上記
タグ	リフレクションで取得したクラス名＋メソッド名
メッセージ	ログメッセージ

他のアプリケーションがどういうメッセージを出力しているのかを参考にしてみてはどうでしょうか。

□参考情報
ログ設計指針
log4j