長い手順はログを分ける。一度ログアウトして入り直す理由
長い手順を同じサーバーで続けると、ログが長くなりすぎて後から見返すのが大変になります。作業の区切りで一度ログアウトして入り直し、ログを分けておく大切さと、分け方の目安をまとめました。
ログ、1本にまとめていませんか?
こんにちは、コマンド学習道場を運営しているこすけです。
今回は作業ログの「分け方」の話。
結論から言うと、長い手順のときは、同じサーバーでも一度ログアウトして入り直し、ログを分けたほうがいいです。
「同じサーバーなんだから、つないだまま続けたほうがラクじゃない?」と思いますよね。
私も最初はそう思っていました。
でも、あとからログを見返す場面を考えると、話はまったく別なんです。
長い手順だとログはどんどん長くなる
運用保守の作業では、ターミナルの操作をログとして残すのが基本。
いわゆる証跡ですね。
手順が短ければ、1本のログでも特に困りません。
問題は、手順が長いとき。
事前確認、設定変更、サービスの再起動、事後確認……と続いていくと、ログはあっという間に何百行、何千行にもなります。
しかも、後続の作業も同じサーバーだと、つい接続したまま次の作業に入ってしまいがち。
そうなると、ひとつのログファイルの中に、いくつもの作業がずらっと並んだ状態になるわけです。
あとから見返すと、とにかく読みにくい
作業中は、自分が今どこをやっているか頭に入っているので、ログが長くても気になりません。
困るのは、あとから見返すときです。
たとえば「設定変更の前後で何が変わったか確認したい」と思ってログを開いたとします。
でも、ログが長すぎて、目的の部分がどこにあるのかすぐに見つからない。
上から下までスクロールして、それっぽいコマンドを探して……というのは、正直かなりしんどいです。
自分で見返すならまだしも、先輩やチームの人がチェックする場合はなおさら。
ログは自分のためだけでなく、あとから読む人のためにもあるので、読みやすさはかなり大事なんですよね!
一度ログアウトして入り直す
そこで大事なのが、作業の区切りで一度ログアウトして、入り直すこと。
ログアウトすれば、そこでひとつのログが閉じる。
入り直せば、新しいログが始まる。
これだけで、1本のログに1つの作業という形にできるんです。
Linux の script コマンドを使ったログの取り方だと、イメージはこんな感じ。
$ script ~/log/20261109_web01_01_precheck.log # 事前確認のログを取り始める
Script started, output log file is '/home/user/log/20261109_web01_01_precheck.log'.
$ systemctl is-active nginx
active
$ exit # ここで1本目のログを閉じる
Script done.
$ script ~/log/20261109_web01_02_change.log # 設定変更は別のログに
ターミナルソフトの自動ログ機能を使っている場合も、考え方は同じ。
接続し直せば、そのたびに新しいログファイルができます。
ファイル名に日付やサーバー名、作業の順番や内容を入れておくのもおすすめ。
ファイル名を見るだけで、どのログに何が入っているかわかるので、探す手間が一気に減りますよ。
分けておくと助かる場面
ログを分けておくと、見返すとき以外にも助かる場面があります。
ひとつは、作業中に何かトラブルが起きたとき。
ログが作業ごとに分かれていれば、「どの作業の、どのあたりでおかしくなったのか」をすぐに絞り込めます。
原因を探す範囲が小さくなるので、落ち着いて確認しやすくなるんです。
もうひとつは、ログを人に渡すとき。
作業報告に事後確認の結果だけを添付したい、先輩に設定変更の部分だけ見てほしい、ということは意外と多いもの。
1本の長いログから必要な部分を切り出すのは手間ですが、最初から分かれていれば、そのファイルを渡すだけで済みます。
相手が読む量も減らせるのは、地味ですがかなり大きいですよね。
区切りの目安は「作業のまとまり」
どこで区切るかは、現場の手順やルールによって違います。
なので、まずは自分の現場の決まりを確認しておきましょう。
特に決まりがない場合は、手順書の大きな区切りごとにログを分けるのがわかりやすいと思います。
事前確認、作業、事後確認、のようなイメージです。
以前のコラム「プロンプトに戻ったら改行する癖を付ける」で、ログの中に空行を入れて区切りをつける話を書きました。
改行がログの「中」の区切りだとすると、ログアウトはログ「そのもの」の区切り。
この2つを組み合わせると、ぐっと読みやすいログになります。
読みやすいログは、作業の質も上げる
ログを分けるのは、ほんのひと手間です。
でも、そのひと手間で、あとから見返す自分も、チェックする先輩も、ずいぶんラクになります。
それに、区切りごとにログアウトすると、気持ちの切り替えにもなるのが地味にいいところ。
「ここまでの作業は終わり、次はこれ」と頭の中が整理されるので、ミスも減らせるはずです。
長い手順の作業をするときは、ぜひ一度ログアウトして入り直すことを意識してみましょう!
練習用ターミナルで、exit と入り直しの流れを試してみるのもおすすめですよ。