背景

アプリケーションのログはとても大事…ですよね。

開発中は影が薄いですが、運用中にはきちんと考えて出力できているログは頼りになります。
ただ、ログレベルの設定方法やログの監視方法などは様々なノウハウが共有されていますが、何を出力すべきか論じられているのは少ない印象です。
ワークロードの違いで出力すべきログが全然違ったりはしますが、多くのアプリケーションで共通となる部分もあると思っています。

この記事ではその共通部分の一つ、起動ログについて有用と思うことをまとめて書いています。

起動ログとは

ここでいう起動ログとは、バックエンドのデーモンやバッチなどでアプリケーションが正常起動したときに出力する情報です。
※ もしかしたら他に一般的な名称があるかも

私が書いているアプリケーションでは、起動すると以下のようなログを出力しています。

{
  "level":"info",
  "ts":"2022-07-21T05:21:15Z",
  "msg": "startup",
  "appName":"my_module",
  "appVersion": "v1.0.0",
  "option": "{\n \"Env\": \"production\",\n  \"Port\": 80\n}"
}