何をログ出力して保存すべきなのでしょうか？

Question

非常に初歩的な質問で恐縮ですが、前から気になっていた素朴な疑問があります。
表題の通りなのですが、Webアプリケーションフレームワークにはたいてい、ログ用のモジュールが含まれていると思います。

このロギングなのですが、どういう時に（どういう箇所で）使うものなのでしょうか？
いまいち、目的や用途などが分かっていません。

とは言え、最近読んだ本の中の一部を通して少し分かったような気もしますが、
例えば、データベースの接続エラーが起きて、エラーをクライアント側に返すようなコードのところで、
そのエラーをファイルなどに出力して記録しておくみたいな使い方なのかなとは思いました。

あとで、ログをレビューしてどんなエラーが起きているかを確認して改善、修復に利用したり、
致命的なエラーが報告された時にその原因をログから調べたりとか、そういった使い方をするのが主なのですかね？

つまり、エラーが発生した時の例外処理などをするところに、ログ出力の処理を入れておくと良いのでしょうか？

ログと一言でいっても、アクセスログなどもあるかとは思いますが。。。（google analyticsにそういったのは任せてしまうので、アクセスログをとるようなこともしたことがなく。。。）

Answer 1

あとで、ログをレビューしてどんなエラーが起きているかを確認して改善、修復に利用したり、致命的なエラーが報告された時にその原因をログから調べたりとか、そういった使い方をするのが主なのですかね？

そうですね。その視点で良いと思います。

hayatomoさんが書かれているように、アクセスログや統計情報といったものはそれ専用の仕組みを持って収集するほうが確実で運用負荷も低いので、それはログに記録しません（要件によっては、監査ログのために記録が必要な場合もあります）。

ログに書いてはいけない情報もあり、個人情報やパスワードなどはログには出すべきではありません。

後は、問題が起きたときに、問題に遭遇した利用者に手順を聞かなくても分かるようなログが出力されていれば良いです。この問題が起きそうなところ、問題が起きたら解決が面倒そうなところにログを仕込んでおくと良いです。それは、if/elseの処理で絶対に到達しないはずの分岐に来てしまったときや、決済サーバーとの通信、時間のかかる非同期バッチへ処理を依頼したとき、かもしれません。後者2つはどちらも外部システムとの通信なので、処理を発行したときのID的な識別子をログに入れておくと、外部システム側のログや履歴と突き合わせできるようになります。

また、Webアプリは複数人のアクセスが同時に発生するので、ログも複数が入り交じります。人かブラウザを判別するIDか何かをログに記録しておく必要があります。

上記のような視点でログを書くとき、ログレベルとして「何かあった時用（DEBUG, INFO, WARNING）」と「このログが出たらマズイ（ERROR, FATAL, CRITICAL, SEVERE）」という大きく2つのレベルがあります（実際にはもっと細かくあると思います）。「このログが出てたらマズイ（ERROR, FATAL, CRITICAL, SEVERE）」のログを書いた人には、どうマズいのか、その時どうするべきなのか、といったことも分かっている（あるいは、どうにもならないということが分かっている）はずなので、「なぜこれが起きたのか」「誰に影響があるのか」「どう対処するべきか」といった情報を記載したページのURLなり、情報そのものなりを一緒にログに出すと良いです。

Comments

[退会済みユーザー]

ご回答ありがとうございます！非常に参考になります！！！この辺をよく理解出来なかったので、後ほど、
時間を改めて質問させて頂けると嬉しいです！”決済サーバーとの通信、時間のかかる非同期バッチへ処理を依頼したとき、かもしれません。後者2つはどちらも外部システムとの通信なので、処理を発行したときのID的な識別子をログに入れておくと、外部システム側のログや履歴と突き合わせできるようになります。”

[退会済みユーザー]

"決済サーバーとの通信、時間のかかる非同期バッチへ処理を依頼したとき、かもしれません。後者2つはどちらも外部システムとの通信なので、処理を発行したときのID的な識別子をログに入れておくと、外部システム側のログや履歴と突き合わせできるようになります。"

[退会済みユーザー]

↑
こちらの件なのですが、通信前にログを出力し、さらに通信後にエラーが起きそうなところにもログ出力を仕込む感じでしょうか？

[shimizukawa]

まさにログで何を見たいのか、ですね。
ある関数が呼び出された、関数が終了した、といったことを知りたければ、関数の最初おと最後にログ出力を埋めておきます。一般的には、そういうトレースログはdebugレベルで出力して、実運用中は記録しないようにしますが、時々必要なときもあります。

外部APIを呼び出すときのリクエストパラメータとレスポンスを把握したい場合は、そのAPI呼び出しの直前にリクエストパラメータをログ出力＆レスポンスデータをログ出力、する方法があります。個人情報を含むデータの可能性があるので、気をつけてください。APIの呼び出しが膨大な場合はログの保存量 or ログサーバーへの通信量も増えるので、そのあたりの考慮も要りそうです。

[退会済みユーザー]

ご回答ありがとうございます！！ちょっと読み込んでからまたお礼も兼ねてコメントいたします！ありがつおございます！！！

[退会済みユーザー]

実際に運用していくと、「これをログで確認したい！」みたいなのが出てくるのでしょうね！！とても参考になるご回答ありがとうございました！！ログれるようになります！