#自己紹介
初めまして、2019年4月からSierのエンジニアとしてデビューしたポンコツエンジニアです。
これまでQiitaにはお世話になってきましたが、忘れっぽい自分のためにメモ書きとして残していきます。
現在はC#を使ってシステムの改修作業を行っています。
#概要
今回の改修作業では、画面イメージ作成と画面制御を担当していました。
ソフトウェア詳細設計から行い、デバッグ作業に入って気づいたログの大切さ。
自分なりの解釈で残していきます。
注)ログの残し方は、業務によって決まっていると思うので、残すタイミングは要確認です。
#結論
ユーザインタフェースログ（以下※UIログ）はエラー発生時、担当エンジニア(作成者とは別のエンジニア)がUIログを見てトレース(追いかける)する為に必要です。
残す時に意識するのは
- 場所（エラー発生箇所）
- タイミング
-
発生時に持っている値
を残した方がいいです。
#ログの重要性
結論で述べたように、何も知らないエンジニアが見ても分かるようにした方がいいです。
何かシステムバグが発生した場合に、あなたは仕事を辞めているかもしれない。
そんな中、保守作業を行うエンジニアがログを見て、ソースを調べたら原因が分かるような残し方がいいです。
ソースを見なくても分かるように残すとするとログを大量排出する事になる為、
ログのボリュームが増えてしまいます。
##発生した訳
1.テストを行う
2.何かしらのバグが見つかる
3.上司に報告する
4.「ログを見た？」と毎回聞かれる
残し方を知らなくてもログで大体のエラー発生箇所は書いてあるので、エラーの箇所はわかります。
自分が作成するログは「 残すもの」という浅い考えだった為、各関数の処理が始まる前に「画面名」「文言」「状態(値)」を残していました。
同画面で、動きがない場合もログを残していました。
(「状態」は何も参照していないのに残していました。)
##問題点
改修作業で追加の場合は、基本的に既存ソースを流用して作成しますが、
既存と新規追加の画面で処理内容が変わっているのに、合わせるのを意識しすぎて無駄に処理を増やしていました。
##気をつける点
次の処理が、ある値によって変わる場合などはログに出力を行う。
次の処理が決まっている場合はログへの出力は省いても問題はないと思います。
#最後に
こんな拙い文章を読んで頂きありがとうございます。
間違っている、わかりづらい点をコメント頂ければ私も勉強になりますのでお願いします。
プログラミングの細かい内容ではありませんが、ログの残し方がまだ分からない自分自身の為に残しておきました。