コードを書いているときに， ログ出力したくなる場合がある．
OCaml の場合のログ出力に使うことのできるライブラリとして，以下などがある．
-
Async は Jane Street が開発している並行プログラミング用ライブラリ．
恐らくは OCaml でのウェブ開発などではこれを用いることが多いのではないかと思っている． よく知らないけど．
Async の中には Log モジュールが存在する．
Async を用いている場合は，これを使う一択だと思われる．
-
Logs はログ出力ためだけのシンプルなライブラリ．
Logs のドキュメントは ここにある．
今回はこちらを使ってみる．
シンプルな使い方
まず，Logs をインストールする．
opam install logs
ビルドシステムに dune を使っている場合は， dune ファイルの依存関係に以下のように logs を追加する．
;; dune
(executable
(name main)
(libraries logs logs.fmt)
)
OCaml コードの中では，以下のようにして使うことができる．
(* main.ml *)
let () =
(* 標準の「reporter」を用いる（カスタム reporter については後で解説する）． *)
Logs.set_reporter (Logs_fmt.reporter ());
(* ログ出力のレベルを INFO に設定する（DEBUG などは出力しないようにする）． *)
Logs.set_level (Some Logs.Info);
(* INFO レベルのログを出力．Printf モジュールのようにして使うことができる． *)
Logs.info (fun m -> m "Hello World! %d" 42);
このコードを実行すると，以下のようにログが出力できる．
$ dune exec ./main.exe
main.exe: [INFO] Hello World! 42
タイムスタンプも表示させるには
ログに時刻も表示させるようにしたい．
このためには，カスタム reporter を実装して，それを指定してやれば良い．
時刻の取得などのために，今回は Core ライブラリ と Core_unix を用いたので， まずはそれをインストールしてやる．
（OCaml 標準ライブラリのものを利用しても良い．）
opam install core
opam install core_unix
dune ファイルの依存関係に Core, Core_unix も追加してやる．
;; dune
(executable
(name main)
(libraries core core_unix logs logs.fmt)
)
タイムスタンプを取得する関数と， カスタム reporter を実装する．
この際に，今回は main.ml にではなく， util.ml という別ファイルを用意してそこに実装している．
（main.ml に直接実装しても良いが．）
util.ml の実装は以下のようになる．
(* util.ml *)
open Core
(** ログ出力用のタイムスタンプを文字列として返す． *)
let get_timestamp () =
let now = Core_unix.time () in
let tm = Core_unix.localtime now in
let timestamp =
Format.asprintf "%04d-%02d-%02d %02d:%02d:%02d"
(tm.Core_unix.tm_year + 1900)
(tm.Core_unix.tm_mon + 1) tm.Core_unix.tm_mday tm.Core_unix.tm_hour
tm.Core_unix.tm_min tm.Core_unix.tm_sec
in
timestamp
(** タイムスタンプを用いたログ出力のための設定． *)
let reporter () =
let report _src level ~over k msgf =
let k _ =
over ();
k ()
in
msgf @@ fun ?header:_ ?tags:_ fmt ->
let timestamp = get_timestamp () in
if Poly.( = ) level Logs.App then
Format.kfprintf k Format.std_formatter ("@[" ^^ fmt ^^ "@]@.")
else
Format.kfprintf k Format.std_formatter
("%s [%a] @[" ^^ fmt ^^ "@]@.")
timestamp Logs.pp_level level
in
{ Logs.report }
カスタム reporter の実装の詳細は余力があるタイミングで調べて拡充する．．．
正直，今は何をやっているのか，全然理解していない．
Logs のドキュメントには カスタム reporter の実装サンプルも書いてあり， こちらを参考に改変したのだが， このサンプルは Tag という機能？も組み合わせた例になっており， 私には初見ではイマイチ理解できなかった．
カスタム reporter を使うには， main.ml での reporter の設定を， 以下のようにしてやれば良い．
(* main.ml *)
let () =
(* カスタム reporter を用いる． *)
Logs.set_reporter (Util.reporter ());
Logs.set_level (Some Logs.Info);
Logs.info (fun m -> m "Hello World! %d" 42);
この出力結果は以下のようになる．
$ dune exec ./main.exe
2024-10-23 21:34:57 [INFO] Hello World! 42
ブラーボ．
参考
-
このブログを先に見つけていたら，本稿は書いてなかったと思うが．．． まぁ本稿はタイムスタンプの表示をするサンプルコードを載せたということで．
-
どうやら初期設定でタイムスタンプも出してくれるっぽい． かなり良さげに見える．これを使うべきだったかもしれない．
