skillup

技術ブログ

プログラミング全般

ログのまとめに関して

投稿日:2021年3月20日 更新日:

何回か書いたログの設計方針に関して再度復習。

ログ設計指針について

ログで大事なことを再度復習

  • DEBUG(SQLやパラメータ情報など詳細な情報までだす)、INFO(メソッドの詳細情報、開始と終了)、WARNING(処理は止めないが、警告として知らせたい情報。処理が完全ではないなど)、ERROR(異常終了する際の告知。メールや別のチャネルなどで知らせる必要があるかも)、FATAL(例外エラーなど。ERRORはif文などでキャッチできるエラー。FATALはExceptionなど)
  • SQLやパラメータは重要度によってINFOに格上げしてもいいかも(InパラメータのJSONのパラメータなどを入れておくとデバッグが楽)
  • クラス名、メソッド、行数、時間入れておくと楽。時間はマスト
  • 面倒でなければメソッドのInパラメータは吐いた方が良い(追跡が楽)
  • ログにだす情報は改行しないほうがいいかも・・。(特にSQL)不必要に改行を入れると非常にみにくい
  • 多くなりすぎなければ正常系の処理が終わった後につけるのも良い。
  • ログには記号+番号などを入れておくと検索が楽。ログが出た場所をすぐに特定できるために。
  • HTMLデータやパラメータが多すぎるものときなどは文字制限を入れないとログデータ自体が多すぎることがあるので必要に応じて少なくした方が良いかも・・
  • ログに出す詳細情報はInパラメーター、キー系のID情報、エラーメッセージ。
  • エラーメッセージはstackTraceなどがはっきりと出ることを確認しておくこと
  • 共通度が高いメソッドなどはログが大量に出て他の部分を邪魔することもあるので出し分け要注意。
  • 複数のバッチが入るときはチャネルを分けると処理が混ざらないので見やすいかも。
  • 集計することがあるのでキー系の情報がはっきりと拾えるようにしておくこと

-プログラミング全般
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

アクセストークンの分類について

認可情報を取得する際に、ID &パスワードではなく、アクセストークンで認証を行うサービスは多いと思うのですが、アクセストークンにも色々ありますので、再度まとめておこうと思います。 以前まとめた …

no image

エラーレポーティングサービス Sentryについて

リリースした後、運用段階に入ると定期的にバグ報告が上がってきます。 本来はリリース前に研修テストをすべきなんですが、そんな余裕ないことも多い(汗) で、そんな時に大事なのが エラーを気づけること 対処 …

no image

コードの分割

今回はリーダブルコードの8章。コードの分割について。 ポイントとしては1行に情報を詰め込みすぎているような場合は分割して、意味がわかりやすい区切りにまとめよう、といったことでしょうか。つまりは「困難は …

no image

OSコマンドインジェクション

Contents1 OSコマンドインジェクションとは?2 被害3 対策4 参考リンク OSコマンドインジェクションとは? OSに対する命令文を不正に紛れ込ませて攻撃させる手法。 被害 サーバー内のファ …

no image

Simple Factoryパターンについて

今回はデザインパターンの一種であるSimple Factoryパターンに関して。 Contents1 Simple Factoryパターンとは2 サンプルコード3 解説 Simple Factoryパ …

アーカイブ