loggerパッケージはRのログ出力に使います。ログはプログラムの進捗確認や、問題発生時のデバグなどに便利なので、ぜひ活用したいところですね。

特に構造化ログを使うと、ログ解析がしやすくなっていいよという話をJapan.R 2024で発表しました。

2024-12-10 Japan.R 2024で構造化ログについて発表した

構造化ログとして一般的に用いられるフォーマットはJSONです。以下のように{}の間に"key": "value"形式で記述された1行のJSONが1件のログとして出力されます。

logger::log_formatter(logger::formatter_json)
logger::log_layout(logger::layout_json_parser(fields = c("time", "level")))
logger::log_info(message = "これはINFOログです")
#> {"time":"2025-01-27 09:10:58","level":"INFO","message":"これはINFOログです"}

ところが、当時のloggerパッケージで構造化ログを出力すると、layout_json_parser関数で指定するメタフィールドの名前が固定で変更できないという問題がありました。上記の例ではtimeやlevelといったフィールドの名前が固定です。

これでは、他の製品のログと書式を統一しにくい、ログ管理ツールの指定するフィールド名と整合しない、という問題が起こりえます。

そこで、loggerパッケージにPRして、メタフィールドの名前を変更できるようにしてもらいました。

2024-01-27時点では、CRANにリリースされていないので、GitHubからインストールする必要があります。

pak::pak("daroczig/logger")

名前の変更方法はtidyverseユーザーにとって馴染みやすい、dplyr::rename関数方式です。

data.frame(x = 1) |> dplyr::rename(y = x)
#>   y
#> 1 1

layout_json_parser関数では使いたいメタフィールドの名前をcharacterベクトルとして指定できます。この時、変更先の名前をベクトルの要素の名前に使えばOKです。

logger::log_formatter(logger::formatter_json)
logger::log_layout(logger::layout_json_parser(
  # fields引数に名前つきベクトルを指定すると
  # メタフィールドを改名できる
  fields = c(timestamp = "time", loglevel = "level")
))
logger::log_info(message = "これはINFOログです")
#> {"timestamp":"2025-01-27 09:10:58","loglevel":"INFO","message":"これはINFOログです"}

2ヶ月ほど前にPRして音沙汰なしだったので、メンテされているか不安だったのですが、無事にマージされて安心しました。次はログのタイムスタンプをミリ秒やマイクロ秒の精度で扱ったり、任意のフォーマットで出力できるようにするPRを書いています。

feat: format timestamp
https://github.com/daroczig/logger/pull/226

皆さんのログ管理が少しでも楽になりますように！