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

PHPの例外クラスについて

PHPの例外クラスについて今まで一方的にExceptionで受けており、それ自体は問題なさそうですが、 一応再度確認。 Contents1 エラークラスの分類2 Throwableに関して3 Exce …

no image

abstract,interface,traitなどについて

昔はようわからなかったabstract(継承全般)、interface、traitの使い分けなどについて。 今の現場でいろいろと考えることがあり、自分なりにいろんな方の知見を共有できたので、メモしてお …

no image

ログの設計指針について

今まで10以上近い現場で仕事をしてきましたが、どの現場でも絶対必要になる(かつどこもあまり対策が取られていない)技術としては 検証したい状態の復元がすぐにできる(テストデータ作成) ログの適切な設計 …

no image

ExcelVBAに関して(主にプロシージャ)

いつも半年ごとぐらいに触っていてあまり知識が蓄積しないので(汗)これを機につまづいたところをちょっとメモ。 Contents1 基本2 メモ3 参考リンク 基本 基本的な変数の代入や条件分岐、ループな …

no image

コードレビュー時のポイント

コードレビュー(仕様的な点ではなくて規約的なところのチェック)などで気をつけることなど。 ポイントとしては検知ツールで確認するコストを減らすことが一番大事(カスタマイズの方法について調べておく)、ある …

アーカイブ