package ppx_minidebug
Install
Dune Dependency
Authors
Maintainers
Sources
md5=850390df0384d0e0b11c966350c0862a
sha512=b558bf8504c9cfbddd85489a2135fa6d98a6758be21d7bae7e217332778577a2926b90e2a86489a78e92cc2ee43ea04bda1267eca12203af76e0b2b711a51fd6
README.md.html
ppx_minidebug
ppx_minidebug
: Debug logs for selected functions and let-bindings
ppx_minidebug
traces let bindings and functions within a selected scope if they have type annotations. ppx_minidebug
offers three ways of instrumenting the code: %debug_pp
and %debug_show
(also %track_pp
, %diagn_pp
and %track_show
, %diagn_show
), based on deriving.show
, and %debug_sexp
(also %track_sexp
, %diagn_sexp
) based on sexplib0
and ppx_sexp_conv
. Explicit logs can be added with %log
within a debug scope (%log
is not a registered extension point to avoid conflicts with other logging frameworks). The syntax extension expects a module Debug_runtime
in the scope. The ppx_minidebug.runtime
library (part of the ppx_minidebug
package) offers multiple ways of logging the traces, as helper functions generating Debug_runtime
modules. See the generated documentation for Minidebug_runtime
.
Take a look at ppx_debug
which has complementary strengths!
Try opam install ppx_minidebug
to install from the opam repository. To install the development version of ppx_minidebug
, download it with e.g. gh repo clone lukstafi/ppx_minidebug; cd ppx_minidebug
and then dune build; opam install .
.
To use ppx_minidebug
in a Dune project, add/modify these stanzas: (preprocess (pps ... ppx_minidebug))
, and (libraries ... ppx_minidebug.runtime)
.
Here we define a Debug_runtime
either using the entrypoint module Debug_runtime = (val Minidebug_runtime.debug ())
, or using the PrintBox
functor, e.g.:
module Debug_runtime =
Minidebug_runtime.PrintBox((val Minidebug_runtime.shared_config "path/to/debugger_printbox.log" end))
The logged traces will be pretty-printed as trees using the printbox
package. Truncated example (using %debug_sexp
):
BEGIN DEBUG SESSION
"test/test_debug_sexp.ml":7:19-9:17: foo
├─x = 7
├─"test/test_debug_sexp.ml":8:6: y
│ └─y = 8
└─foo = (7 8 16)
"test/test_debug_sexp.ml":15:19-17:14: bar
├─x = ((first 7) (second 42))
├─"test/test_debug_sexp.ml":16:6: y
│ └─y = 8
└─bar = 336
"test/test_debug_sexp.ml":21:19-24:28: baz
├─x = ((first 7) (second 42))
├─"test/test_debug_sexp.ml":22:17: _yz
│ └─_yz = (8 3)
├─"test/test_debug_sexp.ml":23:17: _uw
│ └─_uw = (7 13)
└─baz = 359
"test/test_debug_sexp.ml":28:19-30:17: lab
├─x = 7
├─"test/test_debug_sexp.ml":29:6: y
│ └─y = 8
└─lab = (7 8 16)
"test/test_debug_sexp.ml":34:24-40:9: loop
├─depth = 0
├─x = ((first 7) (second 42))
├─"test/test_debug_sexp.ml":38:8: y
│ ├─"test/test_debug_sexp.ml":34:24-40:9: loop
│ │ ├─depth = 1
│ │ ├─x = ((first 41) (second 9))
│ │ ├─"test/test_debug_sexp.ml":38:8: y
│ │ │ ├─"test/test_debug_sexp.ml":34:24-40:9: loop
│ │ │ │ ├─depth = 2
│ │ │ │ ├─x = ((first 8) (second 43))
│ │ │ │ ├─"test/test_debug_sexp.ml":34:24-40:9: loop
│ │ │ │ │ ├─depth = 3
│ │ │ │ │ ├─x = ((first 44) (second 4))
│ │ │ │ │ ├─"test/test_debug_sexp.ml":34:24-40:9: loop
│ │ │ │ │ │ ├─depth = 4
│ │ │ │ │ │ ├─x = ((first 5) (second 22))
│ │ │ │ │ │ ├─"test/test_debug_sexp.ml":34:24-40:9: loop
│ │ │ │ │ │ │ ├─depth = 5
│ │ │ │ │ │ │ ├─x = ((first 23) (second 2))
│ │ │ │ │ │ │ └─loop = 25
Traces in HTML or Markdown as collapsible trees
The PrintBox
runtime can be configured to output logs using HTML or Markdown. The logs then become collapsible trees, so that you can expose only the relevant information when debugging. Example configuration:
module Debug_runtime =
Minidebug_runtime.PrintBox ((val Minidebug_runtime.shared_config "debug.html"))
let () = Debug_runtime.(html_config := `Html default_html_config)
let () = Debug_runtime.boxify_sexp_from_size := 50
Here we also convert the logged sexp
values (with at least 50 atoms) to trees. Example result:
Highlighting search terms
The PrintBox
runtime also supports highlighting paths to logs that match a highlight_terms
regular expression. For example:
To limit the highlight noise, some log entries can be excluded from propagating the highlight status using the exclude_on_path
setting. To trim excessive logging while still providing some context, you can set prune_upto
to a level greater than 0, which only outputs highlighted boxes below that level.
PrintBox
creating helpers with defaults: debug
and debug_file
The configuration for the above example is more concisely just:
module Debug_runtime = (val Minidebug_runtime.debug_file ~highlight_terms:(Re.str "169") "debug")
Similarly, debug
returns a PrintBox
module, which by default logs to stdout
:
module Debug_runtime = (val Minidebug_runtime.debug ())
Hyperlinks to source locations
The HTML and Markdown outputs support emitting file locations as hyperlinks. For example:
module Debug_runtime = (val Minidebug_runtime.debug_file ~hyperlink:"" "debug")
where ~hyperlink
is the prefix to let you tune the file path and select a browsing option. For illustration, the prefixes for Markdown / HTML outputs I might use at the time of writing:
~hyperlink:"./"
or~hyperlink:"../"
depending on the relative locations of the log file and the binary~hyperlink:"vscode://file//wsl.localhost/Ubuntu/home/lukstafi/ppx_minidebug/"
if left-clicking a link from within VS Code Live Preview follows the file in the HTML preview window rather than an editor window, middle-click the link
~hyperlink:"https://github.com/lukstafi/ppx_minidebug/tree/main/"
Recommended: values_first_mode
This setting puts the result of the computation as the header of a computation subtree, rather than the source code location of the computation. I recommend using this setting as it reduces noise and makes the important information easier to find and visible with less unfolding. Another important benefit is that it makes hyperlinks usable, by pushing them from the summary line to under the fold. I decided to not make it the default setting, because it is not available in the Flushing
runtime, and can be confusing.
For example:
module Debug_runtime =
(val Minidebug_runtime.debug ~highlight_terms:(Re.str "3") ~values_first_mode:true ())
let%debug_this_show rec loop_highlight (x : int) : int =
let z : int = (x - 1) / 2 in
if x <= 0 then 0 else z + loop_highlight (z + (x / 2))
let () = print_endline @@ Int.to_string @@ loop_highlight 7
Truncated results:
BEGIN DEBUG SESSION
┌──────────────────┐
│loop_highlight = 9│
├──────────────────┘
├─"test/test_expect_test.ml":1042:41-1044:58
├─x = 7
├─┬─────┐
│ │z = 3│
│ ├─────┘
│ └─"test/test_expect_test.ml":1043:8
└─┬──────────────────┐
│loop_highlight = 6│
├──────────────────┘
├─"test/test_expect_test.ml":1042:41-1044:58
├─x = 6
├─z = 2
│ └─"test/test_expect_test.ml":1043:8
└─┬──────────────────┐
│loop_highlight = 4│
├──────────────────┘
├─"test/test_expect_test.ml":1042:41-1044:58
When logging uses sexps and boxification, and the result is decomposed into a subtree, only the header of the result subtree is put in the header line, and the rest of the result subtree is just underneath it with a <returns>
or a <values>
header. Example showcasing the printbox-html
backend:
Example showcasing the printbox-md
(Markdown) backend:
Usage
Tracing only happens in explicitly marked lexical scopes. The entry extension points vary along four axes:
%debug_
vs.%track_
vs.%diagn_
The prefix
%debug_
means logging fewer things: only let-bound values and functions are logged, and functions only when either: directly in a%debug_
-annotated let binding, or their return type is annotated.%track_
also logs: whichif
,match
,function
branch is taken,for
andwhile
loops, and all functions, including anonymous ones.The prefix
%diagn_
means only generating logs for explicitly logged values, i.e. introduced by[%log_entry]
,[%log ...]
,[%log_result ...]
and[%log_printbox ...]
statements.
Optional infix
_this_
puts only the body of alet
definition in scope for logging.let%debug_this_show v: t = compute value in outer scope
will tracev
and the type-annotated bindings and functions insidecompute value
, but it will not traceouter scope
.
Optional infixes
_rt_
and_rtb_
add a first-class module argument to a function, and unpack it asmodule Debug_runtime
for the scope of the function._rt_
uses the module typeMinidebug_runtime.Debug_runtime
._rtb_
uses the module typeMinidebug_runtime.PrintBox_runtime
.This functionality is "one use only": it applies only to the function the extension point is attached to.
Representation and printing mechanism:
_pp
,_show
, recommended:_sexp
_pp
is currently most restrictive as it requires the type of a value to be an identifier. The identifier is converted to app_
printing function, e.g.pp_int
._show
converts values to strings via the%show
extension provided byderiving.show
: e.g.[%show: int list]
._sexp
converts values to sexp expressions first using%sexp_of
, e.g.[%sexp_of: int list]
. The runtime can decide how to print the sexp expressions. ThePrintBox
backend allows to convert the sexps to box structures first, with theboxify_sexp_from_size
setting. This means large values can be unfolded gradually for inspection.
Plus, there are non-entry extension points %log
, %log_printbox
and %log_result
for logging values. They are not registered, which as a side effect should somewhat mitigate conflicts with other ppx extensions for logging. There's also an un-registered extension point %log_entry
for opening a log subtree.
See examples in the test directory, and especially the inline tests.
Only type-annotated let-bindings, function arguments, function results can be implicitly logged. However, the bindings and function arguments can be nested patterns with only parts of them type-annotated! The explicit loggers %log
and %log_result
take a value and reconstruct its type from partial type annotations (deconstructing the expression), sometimes assuming unknown types are strings. The %log_printbox
logger takes a PrintBox.t
value. The %log_entry
logger takes a string value for the header of the log subtree.
To properly trace in concurrent settings, ensure that different threads use different log channels. For example, you can bind Debug_runtime
locally: let module Debug_runtime = Minidebug_runtime.debug_file thread_name in ...
ppx_minidebug
can be installed using opam
. ppx_minidebug.runtime
depends on printbox
, ptime
, mtime
, sexplib0
.
Breaking infinite recursion with max_nesting_depth
and looping with max_num_children
; Flushing
-based traces
The PrintBox
backend only produces any output when a top-level log entry gets closed. This makes it harder to debug infinite loops and especially infinite recursion. The setting max_nesting_depth
terminates a computation when the given log nesting is exceeded. For example:
module Debug_runtime = (val Minidebug_runtime.debug ())
let%debug_show rec loop_exceeded (x : int) : int =
[%debug_interrupts
{ max_nesting_depth = 5; max_num_children = 1000 };
let z : int = (x - 1) / 2 in
if x <= 0 then 0 else z + loop_exceeded (z + (x / 2))]
let () =
try print_endline @@ Int.to_string @@ loop_exceeded 17
with _ -> print_endline "Raised exception."
Similarly, max_num_children
raises a failure when the given number of logs with the same parent is exceeded. For example:
module Debug_runtime = (val Minidebug_runtime.debug ())
let%debug_show _bar : unit =
[%debug_interrupts
{ max_nesting_depth = 1000; max_num_children = 10 };
for i = 0 to 100 do
let _baz : int = i * 2 in
()
done]
The %debug_interrupts
extension point emits the interrupt checks in a lexically delimited scope. For convenience, we offer the extension point %global_debug_interrupts
which triggers emitting the interrupt checks in the remainder of the source preprocessed in the same process (its scope is therefore less well defined). For example:
module Debug_runtime = (val Minidebug_runtime.debug ())
[%%global_debug_interrupts { max_nesting_depth = 5; max_num_children = 10 }]
let%debug_show rec loop_exceeded (x : int) : int =
let z : int = (x - 1) / 2 in
if x <= 0 then 0 else z + loop_exceeded (z + (x / 2))
let () =
try print_endline @@ Int.to_string @@ loop_exceeded 17
with _ -> print_endline "Raised exception."
let%track_show bar () : unit =
for i = 0 to 100 do
let _baz : int = i * 2 in
()
done
let () = try bar () with _ -> print_endline "Raised exception."
If that is insufficient, you can define a Debug_runtime
using the debug_flushing
builder. E.g. module Debug_runtime = (val Minidebug_runtime.debug_flushing ())
, or module Debug_runtime = (val Minidebug_runtime.debug_flushing ~filename:"path/to/debugger_flushing" ())
(an extension .log
will be added to the file name).
The logged traces are still indented, but if the values to print are multi-line, their formatting might be messy. The benefit of Flushing
traces is that the output is flushed line-at-a-time, so no output should be lost if the traced program crashes. But in recent versions of ppx_minidebug
, uncaught exceptions no longer break logging in the PrintBox
runtime. The indentation is also smaller (half of PrintBox
). Truncated example (using %debug_show
):
BEGIN DEBUG SESSION at time 2023-03-02 23:19:40.763950 +01:00
2023-03-02 23:19:40.763980 +01:00 - foo begin "test/test_debug_show.ml":3:19-5:15
x = 7
foo = [7; 8; 16]
2023-03-02 23:19:40.764000 +01:00 - foo end
2023-03-02 23:19:40.764011 +01:00 - bar begin "test/test_debug_show.ml":10:19-10:73
x = { Test_debug_show.first = 7; second = 42 }
bar = 336
2023-03-02 23:19:40.764028 +01:00 - bar end
2023-03-02 23:19:40.764034 +01:00 - baz begin "test/test_debug_show.ml":13:19-14:67
x = { Test_debug_show.first = 7; second = 42 }
baz = 339
2023-03-02 23:19:40.764048 +01:00 - baz end
2023-03-02 23:19:40.764054 +01:00 - loop begin "test/test_debug_show.ml":17:24-23:9
depth = 0
x = { Test_debug_show.first = 7; second = 42 }
"test/test_debug_show.ml":21:8:
2023-03-02 23:19:40.764073 +01:00 - loop begin "test/test_debug_show.ml":17:24-23:9
depth = 1
x = { Test_debug_show.first = 41; second = 9 }
"test/test_debug_show.ml":21:8:
2023-03-02 23:19:40.764094 +01:00 - loop begin "test/test_debug_show.ml":17:24-23:9
depth = 2
x = { Test_debug_show.first = 8; second = 43 }
"test/test_debug_show.ml":21:8:
2023-03-02 23:19:40.764109 +01:00 - loop begin "test/test_debug_show.ml":17:24-23:9
depth = 3
x = { Test_debug_show.first = 42; second = 10 }
"test/test_debug_show.ml":21:8:
Tracking: control flow branches, anonymous and insufficiently annotated functions
Using the %track_
-prefix rather than %debug_
-prefix to start a debug scope, or using the %debug_trace
extension point inside a debug scope, enables more elaborate tracking of the execution path. It logs which if
, match
, function
branch is taken. It logs the nesting and loop index of for
loops, and the nesting of while
loops. It logs functions even if the return type is not annotated, including anonymous functions; in particular, it logs type-annotated arguments of anonymous functions. To selectively disable these logs, use %debug_notrace
. Note that it disables the logs on a lexical scope, not just on the annotated syntax node (e.g. a specific if
or match
expression).
If you get fewer logs than you expected, try converting %debug_
to %track_
.
For example:
let%track_show track_branches (x : int) : int =
if x < 6 then
match%debug_notrace x with
| 0 -> 1
| 1 -> 0
| _ ->
let result : int = if x > 2 then x else ~-x in
result
else
match x with
| 6 -> 5
| 7 -> 4
| _ ->
let result : int = if x < 10 then x else ~-x in
result
let () =
print_endline @@ Int.to_string @@ track_branches 8;
print_endline @@ Int.to_string @@ track_branches 3
gives:
BEGIN DEBUG SESSION
"test/test_expect_test.ml":415:37-429:16: track_branches
├─x = 8
├─"test/test_expect_test.ml":424:6: <if -- else branch>
│ └─"test/test_expect_test.ml":427:8: <match -- branch 2>
│ └─"test/test_expect_test.ml":428:14: result
│ ├─"test/test_expect_test.ml":428:44: <if -- then branch>
│ └─result = 8
└─track_branches = 8
8
"test/test_expect_test.ml":415:37-429:16: track_branches
├─x = 3
├─"test/test_expect_test.ml":417:6: <if -- then branch>
│ └─"test/test_expect_test.ml":421:14: result
│ └─result = 3
└─track_branches = 3
3
and
let%track_this_show anonymous (x : int) =
Array.fold_left ( + ) 0 @@ Array.init (x + 1) (fun (i : int) -> i)
in
print_endline @@ Int.to_string @@ anonymous 3
gives:
BEGIN DEBUG SESSION
"test/test_expect_test.ml":516:32-517:70: anonymous
├─x = 3
├─"test/test_expect_test.ml":517:50-517:70: __fun
│ └─i = 0
├─"test/test_expect_test.ml":517:50-517:70: __fun
│ └─i = 1
├─"test/test_expect_test.ml":517:50-517:70: __fun
│ └─i = 2
└─"test/test_expect_test.ml":517:50-517:70: __fun
└─i = 3
6
To disable, rather than enhance, debugging for a piece of code, you can use the %diagn_
extension points.
Explicit logging statements also help with tracking the execution, since they can be placed anywhere within a debug scope. Example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ()) in
let%track_sexp result =
let i = ref 0 in
let j = ref 0 in
while !i < 6 do
[%log 1, "i=", (!i : int)];
incr i;
[%log 2, "i=", (!i : int)];
j := !j + !i;
[%log 3, "j=", (!j : int)]
done;
!j
in
print_endline @@ Int.to_string result;
[%expect
{|
BEGIN DEBUG SESSION
"test/test_expect_test.ml":2271:4: <while loop>
├─"test/test_expect_test.ml":2272:6: <while loop>
│ ├─(1 i= 0)
│ ├─(2 i= 1)
│ └─(3 j= 1)
├─"test/test_expect_test.ml":2272:6: <while loop>
│ ├─(1 i= 1)
│ ├─(2 i= 2)
│ └─(3 j= 3)
├─"test/test_expect_test.ml":2272:6: <while loop>
│ ├─(1 i= 2)
│ ├─(2 i= 3)
│ └─(3 j= 6)
├─"test/test_expect_test.ml":2272:6: <while loop>
│ ├─(1 i= 3)
│ ├─(2 i= 4)
│ └─(3 j= 10)
├─"test/test_expect_test.ml":2272:6: <while loop>
│ ├─(1 i= 4)
│ ├─(2 i= 5)
│ └─(3 j= 15)
└─"test/test_expect_test.ml":2272:6: <while loop>
├─(1 i= 5)
├─(2 i= 6)
└─(3 j= 21)
21
|}]
Using as a logging framework
ppx_minidebug
can be used as a logging framework: its annotations can be stored permamently with the source code, rather than shyly added for a brief period of debugging. To allow this, there needs to be a mechanism of logging levels -- otherwise the system is slowed down too much, or even if performance is not an issue, the user is overwhelmed with the amount of logs. ppx_minidebug
addresses these issues in a flexible way, by offering restriction of log levels both at compile time and at runtime.
The %diagn_
extension points (short for "diagnostic") are tailored for the "logging framework" use-case. Within the scope of a %diagn_
extension point, only explicit logs are generated. Therefore, one can freely add type annotations without generating debug logs. As a side-effect, %diagn_
annotations can be used to disable debugging for pieces of code where we need type annotations for code reasons, but do not have serialization/printing functions for the types.
In the PrintBox
backend, logs accumulate until the current toplevel log scope is closed. This is unfortunate in the logging framework context, where promptly informing the user using the logs might be important. To remedy this, PrintBox_runtime
offers the setting snapshot_every_sec
. When set, if sufficient time has passed since the last output, the backend will output the whole current toplevel log scope. If possible, the previous snapshot of the same log scope is erased, to not duplicate information. The underlying mechanism is available as [snapshot] in the generic interface; it does nothing in the flushing backend. [snapshot] is useful when there's a risk of a "premature" exit of the debugged program or thread.
The log levels are:
Nothing
-- the runtime should not generate anything, and when used at compile time, the extension should not generate anyppx_minidebug
-related code. However, just changing the log level should not break the code, therefore the runtime-passing transformation (i.e. the first-class-module argument added by the_rt_
and_rtb_
infixes) happens even for theNothing
log level.Prefixed [| prefix1; ... |]
-- only values starting with one of: prefix1, ... should be logged; at compile time, only logs with literals having one of prefix1, ... as a prefix, should be generated. Moreover, also don't log "empty entries" (see below). To preserve the hierarchical context, also log headers of logging scopes.Prefixed_or_result [| prefix1; ... |]
as above, but also log results of computations. At runtime doesn't output results of an entry if there are no non-result logs.Prefixed [||]
is compile-time only -- outputs all and only explicit logs (i.e.%log
,%log_result
,%log_printbox
,%log_entry
statements).Prefixed_or_result [||]
at compile-time -- as above, but also log results of computations.Prefixed_or_result [||]
at runtime -- only log results of computations if an entry has non-result logs.Nonempty_entries
-- do not log subtrees, such as functions or control flow blocks, that do not have sub-logs. Exception: explicit%log_entry
subtrees.Everything
-- no restrictions.
The %diagn_
extension points are a shorthand for setting the compile-time log level to Prefixed [||]
, or Prefixed prefixes
when the log level has already been either Prefixed prefixes
or Prefixed_or_result prefixes
. Example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ~values_first_mode:true ()) in
let%diagn_show bar { first : int; second : int } : int =
let { first : int = a; second : int = b } = { first; second = second + 3 } in
let y : int = a + 1 in
[%log "for bar, b-3", (b - 3 : int)];
(b - 3) * y
in
let () = print_endline @@ Int.to_string @@ bar { first = 7; second = 42 } in
let baz { first : int; second : int } : int =
let { first : int; second : int } = { first = first + 1; second = second + 3 } in
[%log "for baz, f squared", (first * first : int)];
(first * first) + second
in
let () = print_endline @@ Int.to_string @@ baz { first = 7; second = 42 } in
[%expect
{|
BEGIN DEBUG SESSION
bar
├─"test/test_expect_test.ml":2972:21-2976:15
└─("for bar, b-3", 42)
336
baz
├─"test/test_expect_test.ml":2979:10-2982:28
└─("for baz, f squared", 64)
109 |}]
At runtime, the level can be set via Minidebug_runtime.debug ~log_level
or Minidebug_runtime.debug_file ~log_level
at runtime creation, or via Debug_runtime.config.log_level <- ...
later on. Check out the test suite test_expect_test.ml:"%log runtime log levels while-loop" for examples:
let%track_rtb_sexp result () : int =
let i = ref 0 in
let j = ref 0 in
while !i < 6 do
(* Intentional empty but not omitted else-branch. *)
if !i < 2 then [%log "ERROR:", 1, "i=", (!i : int)] else ();
incr i;
[%log "WARNING:", 2, "i=", (!i : int)];
j := (fun { contents } -> !j + contents) i;
[%log "INFO:", 3, "j=", (!j : int)]
done;
!j
in
...
print_endline
@@ Int.to_string
(result
(Minidebug_runtime.debug ~values_first_mode:true ~log_level:Nonempty_entries
~global_prefix:"Nonempty" ())
());
...
At compile time, the level can be set for a scope with %log_level
, or globally with %global_debug_log_level
. (%log_level
is not registered to minimize incompatibility with other logging frameworks.) For example:
[%%global_log_level Nonempty_entries]
let%track_sexp nonempty () : int =
let i = ref 0 in
let j = ref 0 in
while !i < 6 do
(* Intentional empty but not omitted else-branch. *)
if !i < 2 then [%log "ERROR:", 1, "i=", (!i : int)] else ();
incr i;
[%log "WARNING:", 2, "i=", (!i : int)];
j := (fun { contents } -> !j + contents) i;
[%log "INFO:", 3, "j=", (!j : int)]
done;
!j
let () = print_endline @@ Int.to_string @@ nonempty ()
This will not emit logging code that is above the stated log level. Note that the compile-time pruning of logging happens independently of the runtime log level! This gives more flexibility but can lead to confusing situations.
There's also a way to compile the code adaptively, using a shell environment variable: [%%global_debug_log_level_from_env_var "environment_variable_name"]
. The variable name is case-sensitive, but the values are case-insensitive. The recognized values of the environment variables are:
nothing
: translates toNothing
prefixed_error
: translates toPrefixed [| "ERROR" |]
prefixed_warn_error
: translates toPrefixed [| "WARN"; "ERROR" |]
prefixed_info_warn_error
: translates toPrefixed [| "INFO"; "WARN"; "ERROR" |]
explicit_logs
: translates toPrefixed [||]
nonempty_entries
: translates toNonempty_entries
everything
: translates toEverything
`` (empty): no change
The generated code will check that the compile-time adaptive pruning matches the runtime value of the environment variable. If that's an obstacle, use %%global_debug_log_level_from_env_var_unsafe
which will not perform the check. Using %%global_debug_log_level_from_env_var_unsafe
is very prone to workflow bugs where different parts of a codebase are compiled with different log levels, leading to confusing behavior.
With some "abuse of notation", we use Prefixed [||]
resp. Prefixed_or_result [||]
to mean all-and-only explicit logs (resp. also result logs). Prefixed [||]
only works at compile time. Prefixed_or_result [||]
works as intended when set both at compile time and at runtime: then, it will output all explicit logs, but also results in otherwise-nonempty entries. Example from the test suite:
let module Debug_runtime =
(val Minidebug_runtime.debug ~values_first_mode:true
~log_level:(Prefixed_or_result [||]) ())
in
let%debug_show () =
[%log_level
Prefixed_or_result [||];
let bar { first : int; second : int } : int =
let { first : int = a; second : int = b } = { first; second = second + 3 } in
let y : int = a + 1 in
[%log "for bar, b-3", (b - 3 : int)];
(b - 3) * y
in
let baz { first : int; second : int } : int =
let { first : int; second : int } = { first = first + 1; second = second + 3 } in
[%log "for baz, f squared", (first * first : int)];
(first * first) + second
in
print_endline @@ Int.to_string @@ bar { first = 7; second = 42 };
print_endline @@ Int.to_string @@ baz { first = 7; second = 42 }]
in
[%expect
{|
BEGIN DEBUG SESSION
bar = 336
├─"test/test_expect_test.ml":3073:14-3077:19
└─("for bar, b-3", 42)
336
baz = 109
├─"test/test_expect_test.ml":3079:14-3082:32
└─("for baz, f squared", 64)
109 |}]
The extension point %log_result
lets you benefit from the values_first_mode
setting even when using only explicit logs. Conveying more information in headers lets you explore logs more quickly.
The extension point %log_printbox
lets you embed a PrintBox.t
in the logs directly. Example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ~values_first_mode:true ()) in
let%debug_show foo () : unit =
[%log_printbox
PrintBox.init_grid ~line:5 ~col:5 (fun ~line ~col ->
PrintBox.sprintf "%d/%d" line col)];
[%log "No bars but pad:"];
[%log_printbox
PrintBox.(
init_grid ~bars:false ~line:5 ~col:5 (fun ~line ~col ->
pad @@ sprintf "%d/%d" line col))];
[%log "Now with a frame:"];
[%log_printbox
PrintBox.(
frame
@@ init_grid ~line:5 ~col:5 (fun ~line ~col -> PrintBox.sprintf "%d/%d" line col))]
in
let () = foo () in
[%expect
{|
BEGIN DEBUG SESSION
foo = ()
├─"test/test_expect_test.ml":3324:21-3337:91
├─0/0│0/1│0/2│0/3│0/4
│ ───┼───┼───┼───┼───
│ 1/0│1/1│1/2│1/3│1/4
│ ───┼───┼───┼───┼───
│ 2/0│2/1│2/2│2/3│2/4
│ ───┼───┼───┼───┼───
│ 3/0│3/1│3/2│3/3│3/4
│ ───┼───┼───┼───┼───
│ 4/0│4/1│4/2│4/3│4/4
├─"No bars but pad:"
├─
│ 0/0 0/1 0/2 0/3 0/4
│
│
│ 1/0 1/1 1/2 1/3 1/4
│
│
│ 2/0 2/1 2/2 2/3 2/4
│
│
│ 3/0 3/1 3/2 3/3 3/4
│
│
│ 4/0 4/1 4/2 4/3 4/4
│
├─"Now with a frame:"
└─┬───┬───┬───┬───┬───┐
│0/0│0/1│0/2│0/3│0/4│
├───┼───┼───┼───┼───┤
│1/0│1/1│1/2│1/3│1/4│
├───┼───┼───┼───┼───┤
│2/0│2/1│2/2│2/3│2/4│
├───┼───┼───┼───┼───┤
│3/0│3/1│3/2│3/3│3/4│
├───┼───┼───┼───┼───┤
│4/0│4/1│4/2│4/3│4/4│
└───┴───┴───┴───┴───┘ |}
The extension point %log_entry
lets you shape arbitrary log tree structures. Example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ()) in
let%diagn_show _logging_logic : unit =
let rec loop logs =
match logs with
| "start" :: header :: tl ->
let more =
[%log_entry
header;
loop tl]
in
loop more
| "end" :: tl -> tl
| msg :: tl ->
[%log msg];
loop tl
| [] -> []
in
ignore
@@ loop
[
"preamble";
"start";
"header 1";
"log 1";
"start";
"nested header";
"log 2";
"end";
"log 3";
"end";
"start";
"header 2";
"log 4";
"end";
"postscript";
]
in
[%expect
{|
BEGIN DEBUG SESSION
"test/test_expect_test.ml":3507:17: _logging_logic
├─"preamble"
├─header 1
│ ├─"log 1"
│ ├─nested header
│ │ └─"log 2"
│ └─"log 3"
├─header 2
│ └─"log 4"
└─"postscript"
|}]
Lexical scopes vs. dynamic scopes
We track lexical scoping: every log has access to the entry_id
number of the lexical scope it is in. Lexical scopes are computations: bindings, functions, tracked code branches (even if not annotated with an extension point, but always within some ppx_minidebug
registered extension point). There is also dynamic scoping: which entry a particular log actually ends up belonging in. We do not expose the (lexical) entry id of an individual log, except when the log "wandered" out of all dynamic scopes, or you passed ~verbose_entry_ids:true
when creating a runtime. To be able to locate where such log originates from, pass ~print_entry_ids:true
when creating the runtime, and look for the path line with the log's entry id. When the backend is HTML or Markdown, the entry id is a hyperlink to the anchor of the entry. Example from the test suite:
let module Debug_runtime =
(val Minidebug_runtime.debug ~print_entry_ids:true ~values_first_mode:true ())
in
let i = 3 in
let pi = 3.14 in
let l = [ 1; 2; 3 ] in
(* Messing with the structure of the logs might lead to confusing output. *)
let foo1 = ref @@ fun () -> () in
let foo2 = ref @@ fun () -> () in
let%debug_show bar callback : unit =
foo1 :=
fun () ->
[%log "This is like", (i : int), "or", (pi : float), "above"];
[%log "tau =", (pi *. 2. : float)];
callback ()
in
let%debug_show baz callback : unit =
foo2 :=
fun () ->
[%log i :: (l : int list)];
[%log (i : int) :: l];
callback ()
in
let () =
bar !foo2;
baz !foo1;
bar !foo2
in
let () = !foo2 () in
[%expect
{|
BEGIN DEBUG SESSION
bar = ()
└─"test/test_expect_test.ml":2923:21-2928:19: {#1}
baz = ()
└─"test/test_expect_test.ml":2930:21-2935:19: {#2}
bar = ()
└─"test/test_expect_test.ml":2923:21-2928:19: {#3}
[3; 1; 2; 3]
└─{orphaned from #2}
[3; 1; 2; 3]
└─{orphaned from #2}
("This is like", 3, "or", 3.14, "above")
└─{orphaned from #1}
("tau =", 6.28)
└─{orphaned from #1} |}]
~verbose_entry_ids:true
tags all logs with entry ids, it shouldn't be needed in regular use.
Reducing the size of generated logs
Summary of possibilities:
log levels
no_debug_if
prune_upto
truncate_children
split_files_after
HTML browsers can handle really large files (less luck with Markdown).
The log levels discussed in the previous section certainly reduce the amount generated, but they either help too little (Nonempty_entries
) or they remove logs too indiscriminately (Prefixed
) for use in a debugging context. Dynamically controlling the runtime log level is one option, but there are some other options.
In the PrintBox backend, you can disable the logging of specified subtrees, when the output is irrelevant, would be a distraction, or the logs take up too much space. The test suite example:
let%debug_this_show rec fixpoint_changes (x: int): int =
let z: int = (x - 1) / 2 in
(* The call [x = 2] is not printed because it is a descendant of
the no-debug call [x = 4]. *)
Debug_runtime.no_debug_if (x <> 6 && x <> 2 && (z + 1) * 2 = x);
if x <= 0 then 0 else z + fixpoint_changes (z + x / 2) in
print_endline @@ Int.to_string @@ fixpoint_changes 7
leads to:
"test/test_expect_test.ml":96:43-100:58: fixpoint_changes
├─x = 7
├─"test/test_expect_test.ml":97:8: z
│ └─z = 3
├─"test/test_expect_test.ml":96:43-100:58: fixpoint_changes
│ ├─x = 6
│ ├─"test/test_expect_test.ml":97:8: z
│ │ └─z = 2
│ ├─"test/test_expect_test.ml":96:43-100:58: fixpoint_changes
│ │ ├─x = 5
│ │ ├─"test/test_expect_test.ml":97:8: z
│ │ │ └─z = 2
│ │ └─fixpoint_changes = 4
│ └─fixpoint_changes = 6
└─fixpoint_changes = 9
9
The no_debug_if
mechanism requires modifying the logged sources, and since it's limited to cutting out subtrees of the logs, it can be tricky to select and preserve the context one wants. The highlighting mechanism with the prune_upto
setting avoids these problems. You provide a search term without modifying the debugged sources. You can tune the pruning level to keep the context around the place the search term was found.
Setting the option truncate_children
will only log the given number of children at each node, prioritizing the most recent ones. An example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ~truncate_children:10 ()) in
let () =
let%track_this_show _bar : unit =
for i = 0 to 30 do
let _baz : int = i * 2 in
()
done
in
()
in
[%expect
{|
BEGIN DEBUG SESSION
"test/test_expect_test.ml":350:26: _bar
├─"test/test_expect_test.ml":351:8: <for loop>
│ ├─<earlier entries truncated>
│ ├─i = 26
│ ├─"test/test_expect_test.ml":351:12: <for i>
│ │ └─"test/test_expect_test.ml":352:14: _baz
│ │ └─_baz = 52
│ ├─i = 27
│ ├─"test/test_expect_test.ml":351:12: <for i>
│ │ └─"test/test_expect_test.ml":352:14: _baz
│ │ └─_baz = 54
│ ├─i = 28
│ ├─"test/test_expect_test.ml":351:12: <for i>
│ │ └─"test/test_expect_test.ml":352:14: _baz
│ │ └─_baz = 56
│ ├─i = 29
│ ├─"test/test_expect_test.ml":351:12: <for i>
│ │ └─"test/test_expect_test.ml":352:14: _baz
│ │ └─_baz = 58
│ ├─i = 30
│ └─"test/test_expect_test.ml":351:12: <for i>
│ └─"test/test_expect_test.ml":352:14: _baz
│ └─_baz = 60
└─_bar = () |}]
If you provide the split_files_after
setting, the logging will transition to a new file after the current file exceeds the given number of characters. However, the splits only happen at the "toplevel", to not interrupt laying out the log trees. If required, you can remove logging indicators from your high-level functions, to bring the deeper logic log trees to the toplevel. This matters when you prefer Markdown output over HTML output -- in my experience, Markdown renderers (VS Code Markdown Preview, GitHub Preview) fail for files larger than 2MB, while browsers easily handle HTML files of over 200MB (including via VS Code Live Preview).
Navigating large logs
There are a few ways ppx_minidebug
is helpful with large logs. You can:
Use the HTML backend with foldable trees. Unlike with the Markdown backend, HTML browsers can render really large files.
Set
elapsed_times
to see how much time was spent in a subtree even if it is folded.Use
~time_tagged:Elapsed
to keep track of when in the course of the program particular entries are computed.Enable the Table of Contents feature by e.g. passing
~with_toc_listing:true
; tunetoc_entry
so that the tables of contents are concise enough to provide an overview.
The table of contents generation is enabled via ~with_toc_listing:true
or ~toc_flame_graph:true
or both (for file-based runtimes -- via table_of_contents_ch
for channel-based runtimes). This will create an additional file (name ending in -toc
), mirroring the main logs in a summarized way. Selected log headers are output there preserving the tree structure, and for ~with_toc_listing:true
they look the same as in the main file except there is no folding. The headers are hyperlinks pointing to the main log file (or files, if file splitting is enabled). For ~toc_flame_graph:true
, the entries are put in boxes, like in the depicted example from the test suite. Presenting two configurations here:
Note: if your flame graph trees run into each other, try setting ~flame_graph_separation:50
or higher.
If you collaborate with someone or take notes, you can pass ~print_entry_ids:true
. In HTML and Markdown, this will output links to the anchors of the corresponding log entries. You can share them to point to specific log file locations.
Example demonstrating foldable trees in Markdown:
module Debug_runtime =
(val Minidebug_runtime.debug_file ~elapsed_times:Microseconds ~hyperlink:"./"
~backend:(`Markdown Minidebug_runtime.default_md_config) ~values_first_mode:true
~truncate_children:4 "debugger_sexp_time_spans")
let sexp_of_int i = Sexplib0.Sexp.Atom (string_of_int i)
let () =
let%debug_sexp rec loop (x : int) : int =
Array.fold_left ( + ) 0
@@ Array.init
(20 / (x + 1))
(fun i ->
let z : int = i + ((x - 1) / 2) in
if x <= 0 then i else i + loop (z + (x / 2) - i))
in
print_endline @@ Int.to_string @@ loop 3
Inlined example output, using the Markdown backend for PrintBox. Note that the elapsed time is wallclock time (see mtime
) and is due to fluctuate because of e.g. garbage collection or external system events.
BEGIN DEBUG SESSION
loop = 58435
<16850.93μs>
<earlier entries truncated>
z = 4
<0.50μs>loop = 11685
<3111.59μs><earlier entries truncated>
z = 4
<0.48μs>loop = 1945
<494.56μs><earlier entries truncated>
z = 8
<0.48μs>loop = 190
<41.60μs><earlier entries truncated>
z = 16
<0.41μs>z = 17
<0.42μs>z = 18
<0.45μs>z = 19
<0.45μs>
z = 9
<0.49μs>loop = 190
<41.54μs><earlier entries truncated>
z = 16
<0.42μs>z = 17
<0.45μs>z = 18
<0.41μs>z = 19
<0.45μs>
z = 5
<0.45μs>loop = 1945
<524.86μs><earlier entries truncated>
z = 8
<0.46μs>loop = 190
<42.11μs><earlier entries truncated>
z = 16
<0.45μs>z = 17
<0.45μs>z = 18
<0.45μs>z = 19
<0.42μs>
z = 9
<0.47μs>loop = 190
<42.85μs><earlier entries truncated>
z = 16
<0.43μs>z = 17
<0.43μs>z = 18
<0.45μs>z = 19
<0.42μs>
z = 5
<0.44μs>loop = 11685
<3166.55μs><earlier entries truncated>
z = 4
<0.49μs>loop = 1945
<499.49μs><earlier entries truncated>
z = 8
<0.50μs>loop = 190
<41.51μs><earlier entries truncated>
z = 16
<0.42μs>z = 17
<0.46μs>z = 18
<0.42μs>z = 19
<0.42μs>
z = 9
<0.49μs>loop = 190
<41.39μs><earlier entries truncated>
z = 16
<0.41μs>z = 17
<0.41μs>z = 18
<0.45μs>z = 19
<0.46μs>
z = 5
<0.45μs>loop = 1945
<642.73μs><earlier entries truncated>
z = 8
<0.47μs>loop = 190
<210.44μs><earlier entries truncated>
z = 16
<167.41μs>z = 17
<0.53μs>z = 18
<0.43μs>z = 19
<0.43μs>
z = 9
<0.50μs>loop = 190
<42.02μs><earlier entries truncated>
z = 16
<0.43μs>z = 17
<0.46μs>z = 18
<0.42μs>z = 19
<0.42μs>
Providing the necessary type information
We only implicitly log values of identifiers, located inside patterns, for which the type is provided in the source code, in a syntactically close / related location. PPX rewriters do not have access to the results of type inference. We extract the available type information, but we don't do it perfectly. We propagate type information top-down, merging it, but we do not unify or substitute type variables.
Here is a probably incomplete list of the restrictions:
When types for a (sub) pattern are specified in multiple places, they are combined by matching syntactically, the type variable alternatives are discarded. The type that is closer to the (sub) pattern is preferred, even if selecting a corresponding type in another place would be better.
When faced with a binding of a form:
let pattern = (expression : type_)
, we make use oftype_
, but we ignore all types nested insideexpression
, even if we decomposepattern
.For example,
let%track_sexp (x, y) = ((5, 3) : int * int)
works -- logs bothx
andy
. Also work:let%track_sexp ((x, y) : int * int) = (5, 3)
andlet%track_sexp ((x : int), (y : int)) = (5, 3)
. Butlet%track_sexp (x, y) = ((5 : int), (3 : int))
will not log anything!
We ignore record and variant datatypes when processing record and variant constructor cases. That's because there is no generic(*) way to extract the types of the arguments.
(*) Although polymorphic variant types can be provided inline, we decided it's not worth the effort supporting them.
We do handle tuple types and the builtin array type (they are not records or variants).
For example, this works:
let%track_sexp { first : int; second : int } = { first = 3; second =7 }
-- but compare with the tuple examples above, the alternatives provided above would not work for records.
Hard-coded special cases: we do decompose the option type and the list type. For example:
let%track_show f : int option -> unit = function None -> () | Some _x -> () in f (Some 3)
will log the value of_x
.
Another example of only propagating types top-down:
let%track_show f (l : int option) : int = match l with Some y -> ...
will not logy
whenf
is applied (but it will logl
).Both
let%track_show f : int option -> int = function Some y -> ...
andlet%track_show f l : int = match (l : int option) with Some y -> ...
will logy
.
We try reconstructing or guessing the types of expressions logged with
%log
and%log_result
, see details below.
As a help in debugging whether the right type information got propagated, we offer the extension %debug_type_info
(and %global_debug_type_info
). (The display strips module qualifiers from types.) %debug_type_info
is not an entry extension point (%global_debug_type_info
is). Example from the test suite:
let module Debug_runtime = (val Minidebug_runtime.debug ~values_first_mode:true ()) in
[%debug_show
[%debug_type_info
let f : 'a. 'a -> int -> int = fun _a b -> b + 1 in
let g : 'a. 'a -> int -> 'a -> 'a -> int = fun _a b _c _d -> b * 2 in
let () = print_endline @@ Int.to_string @@ f 'a' 6 in
print_endline @@ Int.to_string @@ g 'a' 6 'b' 'c']];
[%expect
{|
BEGIN DEBUG SESSION
f : int = 7
├─"test/test_expect_test.ml":1446:37-1446:54
└─b : int = 6
7
g : int = 12
├─"test/test_expect_test.ml":1447:49-1447:72
└─b : int = 6
12 |}]
You can also use at the module level: [%%global_debug_type_info true]
, prior to the code of interest.
Explicit logging with %log
(and %log_result
) has different but related restrictions compared to logging of let or argument bindings. We reconstruct the type of the expression from partial type information, where in addition to type annotations we take into account: string, int and float literals, tuple, array, list, and lazy
expresssions. We do not analyze applications, nor constructors other than "nil" []
and "cons" ::
for lists. When a type is unknown, for the whole expression and for a tuple element we assume the type string
. We don't assume string for direct subexpressions of arrays, lists, and lazy
.
Dealing with concurrent execution
For programs with threads or domains running concurrently, you need to ensure that each thread uses its own instance of a debug runtime, writing to its own log file. Currently, ppx_minidebug
doesn't do any checks to prevent abuse: using the same debug runtime instance from multiple threads or opening the same file by multiple debug runtime instances.
We offer three helpers for dealing with multiple debug runtimes. There is an optional runtime instance-level setting global_prefix
, which adds the given information to all log headers coming from the instance.
There are extension points %debug_lb_sexp
, %debug_this_lb_sexp
, %track_lb_sexp
, etc. They call a function _get_local_printbox_debug_runtime ()
, or _get_local_debug_runtime ()
for the _l_
variants, and unpack the argument as module Debug_runtime
(in a function body). The feature helps using a runtime instance dedicated to a thread or domain, since for example _get_local_debug_runtime
can retrieve the runtime using Domain.DLS
. To avoid surprises, this feature only takes effect for directly annotated functions, and unpacks a Debug_runtime
inside the function body (regardless of whether there is a _this_
), so that we get the appropriate runtime for the dynamic local scope.
Example from the test suite:
let i = ref 0 in
let _get_local_debug_runtime () =
Minidebug_runtime.debug_flushing ~global_prefix:("foo-" ^ string_of_int !i) ()
in
let%track_this_l_show foo () =
let () = () in
()
in
while !i < 5 do
incr i;
foo ()
done;
[%expect
{|
BEGIN DEBUG SESSION foo-1
foo-1 foo begin "test/test_expect_test.ml":3783:28:
foo-1 foo end
BEGIN DEBUG SESSION foo-2
foo-2 foo begin "test/test_expect_test.ml":3783:28:
foo-2 foo end
BEGIN DEBUG SESSION foo-3
foo-3 foo begin "test/test_expect_test.ml":3783:28:
foo-3 foo end
BEGIN DEBUG SESSION foo-4
foo-4 foo begin "test/test_expect_test.ml":3783:28:
foo-4 foo end
BEGIN DEBUG SESSION foo-5
foo-5 foo begin "test/test_expect_test.ml":3783:28:
foo-5 foo end
|}]
Another similar feature is the extension points %debug_rtb_sexp
, %debug_this_rtb_sexp
, %track_rtb_sexp
, etc. They add a first-class module argument to a function, and unpack the argument as module Debug_runtime
. At present, passing of the runtime instance to functions needs to be done manually. Note that only the function attached to the _rt_
or _rtb_
extension point is modified, regardless of whether there is a _this_
.
Example from the test suite:
let%track_rtb_show foo l : int =
match (l : int list) with [] -> 7 | y :: _ -> y * 2
in
let () =
print_endline @@ Int.to_string
@@ foo
(Minidebug_runtime.debug ~global_prefix:"foo-1" ~values_first_mode:true ())
[ 7 ]
in
let%track_rtb_show baz : int list -> int = function
| [] -> 7
| [ y ] -> y * 2
| [ y; z ] -> y + z
| y :: z :: _ -> y + z + 1
in
let () =
print_endline @@ Int.to_string
@@ baz
(Minidebug_runtime.debug ~global_prefix:"baz-1" ~values_first_mode:true ())
[ 4 ]
in
let () =
print_endline @@ Int.to_string
@@ baz
(Minidebug_runtime.debug ~global_prefix:"baz-2" ~values_first_mode:true ())
[ 4; 5; 6 ]
in
[%expect
{|
BEGIN DEBUG SESSION foo-1
foo = 14
├─"test/test_expect_test.ml":2029:25-2030:55
└─foo-1 <match -- branch 1> :: (y, _)
├─"test/test_expect_test.ml":2030:50-2030:55
└─y = 7
14
BEGIN DEBUG SESSION baz-1
baz = 8
├─"test/test_expect_test.ml":2040:15-2040:20
├─baz-1 <function -- branch 1> :: (y, [])
└─y = 4
8
BEGIN DEBUG SESSION baz-2
baz = 10
├─"test/test_expect_test.ml":2042:21-2042:30
├─baz-2 <function -- branch 3> :: (y, :: (z, _))
├─y = 4
└─z = 5
10 |}]