package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb
doc/batteries.unthreaded/BatLog/index.html
Module BatLog
Source
Simple logging
This ref holds the output channel for simple logging. Defaults to stderr
This ref holds the text printed before each log message. Defaults to the empty string.
type flag = [
| `Date
(*Print the current date as 2011-06-28
*)| `Time
(*Print the current time as 01:23:45
*)| `Filepos
(*Print the file and linenum of this log command (UNIMPLEMENTED - needs syntax extension)
*)| `Custom of unit -> string
(*Print the results of running the given closure
*)
]
This ref holds the output flags. These flags control how the log messages are output. The default is `Date; `Time
and log messages are printed as:
2011/0628 01:23:45: prefixmessage
log s
logs the message s, returning unit.
As Printf.printf
, only the message is printed to the logging output and prefixed with status information per the current flags and the currently set prefix.
fatal s
logs the message s
and then calls exit 1
. This exits the program with return code 1.
fatalf
allows a format string (as Printf.printf
)and the arguments to that format string to build the logging message. Exits the program with return code 1.
Build a logger module with custom, fixed output, prefix and flags
Returns an object with methods fatal
, fatalf
, log
, and logf
that logs to the given output channel, with given prefix and flags. These methods work like the corresponding functions in the BatLog module.
val make_logger :
'a BatIO.output ->
string ->
[< `Custom of unit -> string | `Date | `Filepos | `Time ] list ->
< fatal : ?fp:string -> string -> 'b
; fatalf :
?fp:string ->
('c, 'a BatIO.output, unit, unit, unit, 'd) format6 ->
'c
; log : ?fp:string -> string -> unit
; logf : ?fp:string -> ('e, 'a BatIO.output, unit) format -> 'e >
The different verbosity levels supported in the Easy
logger
A simple-to-use logger with verbosity levels that outputs by default to stderr (changeable at runtime) with the date and time at the beginning of each log message.