CHANGELOG.md

[2.1.0] -- current

Changed

• %log_level unregistered extension is now setting the dynamic log level in addition to the lexical log level.

[2.0.2] -- 2024-10-18

Changed

• Shared_config now has an init_log_level field, populated from the runtime creation functions' ~log_level argument.
• A header BEGIN DEBUG SESSION is only output when the (initial) log level is greater than 0.
• A debug file is opened (created) lazily, in particular not at initialization if the initial log level is 0.
• We give up on only splitting the flushing backend files at toplevel log boundaries: now a log open and log close can be in different files.

Fixed

• Outdated README comment: local debug runtimes are not restricted to functions.

[2.0.1] -- 2024-09-08

Changed

• values_first_mode is now the default: ?(values_first_mode = true).

Fixed

• Write the whole incomplete log tree on the error "lexical scope of close_log not matching its dynamic scope" by snapshotting, so the entries from the error message can be looked up.
• Don't use str_formatter, it's only meant to be used from the main domain. (It affected timestamps, and _pp entry points for the flushing backend.)

[2.0.0] -- 2024-08-26

Added

• Compile-time explicit log levels %debug1_sexp, %debug2_sexp, %log1, %log2, %log2_result, %log2_entry etc. that participate in compile-time log level filtering.
• Runtime log levels %at_log_level, %logN, %logN_result, %logN_printbox that take the level at which to log as argument. Note: not supported for extension entry points %debug_sexp etc.
• New unregistered extension point %log_block (similar to %log_entry) that assumes its body is logging code only, and does both compile-time and runtime pruning of the body according to the log level. Limited to unit-type bodies.

Changed

• Moved no_debug_if to the generic interface (the last remaining non-config functionality missing from it). It's ignored (no-op) for the flushing backend.
• Moved to linear log levels per-entry and per-log, where an unspecified log level inherits from the entry it's in, determined statically.
• Removed _this_ infix and make all extension points behave as _this_ (not extend to bodies of toplevel bindings).
• Removed _rtb_ and _lb_ -- all debugging should use the generic interface as it now offers all the functionality except configuration.
• Removed a heuristic to not print extra debug information at log level 1 -- replaced by checking for %diagn.

[1.6.1] -- 2024-08-21

Fixed

• Write the log tree on the error "lexical scope of close_log not matching its dynamic scope", so the entries from the error message can be looked up.
• Uncaught exception in the [%%global_debug_log_level_from_env_var "..."] consistency check when the environment variable is not defined.

[1.6.0] -- 2024-08-08

Added

• Runtime description: where the logs are directed to.
• A new family of entry points _l_ resp. _lb_ that retrieve debug runtimes via a call _get_local_debug_runtime () resp. _get_local_printbox_debug_runtime (): these functions are correspondingly expected in the scope. The entry points facilitate using thread-local (and domain-local) debug runtimes.
• Compile-time vs. runtime consistency check for %%global_debug_log_level_from_env_var, and %%global_debug_log_level_from_env_var_unsafe that bypasses the check.

Changed

• Runtime builders take a description optional argument.
• We now check for the compile-time vs. runtime consistency of log level specifications (#45).

Fixed

• _this_ infix on non-let-binding expressions throws a syntax error instead of being a no-op.
  • As a design decision aligned with #51, we output the error instead of processing the expression, i.e. we don't ignore the _this_ infix.
• _rt_ / _rtb_ entry points now work correctly on non-function expressions, making them functions of the debug runtime.
• Not outputting %log_entry when log_level=Nothing.
• Highlighting of <returns> and <values>.

[1.5.1] -- 2024-07-07

Changed

• Outputs entry ids on the stack when reporting static vs. dynamic scope mismatch failure.
• Promotes val snapshot : unit -> unit to the generic interface, implemented as no-op in the flushing backend.
• Does not try to debug module bindings.

[1.5.0] -- 2024-03-20

Added

• An API function Debug_runtime.open_log_no_source for log entries without associated source code locations, and a corresponding [%log_entry] extension point.
• A simple, minimalistic version of a Flame Graph output in ToC files (PrintBox backend only).
• A new ToC criterion: elapsed time threshold.
• And-or gates for ToC criteria.

[1.4.0] -- 2024-03-08

Added

• A setting verbose_entry_ids that prefixes logged values with entry id tags.
• Log entries now generate anchors, HTML syntax: <a id=ENTRY_ID></a>
• Table of Contents, initial version (in the future this might be optionally a flame graph).

Changed

• Fixes #32: optionally output time spans instead of clock times.
• Breaking: renames Debug_ch to Shared_config.
• Breaking: replaces the open_log_preamble_brief and open_log_preamble_full with open_log and a setting location_format.
• Breaking: Adds fname, start_lnum, entry_id parameters to close_log to debug lexical-vs-dynamic scope mismatches and spurious closes.
• Adds global_prefix to the error message on close_log failure.
• Entry ids output with ~print_entry_ids:true now link to the entry anchors.

[1.3.0] -- 2024-02-28

Added

• A new entry extension point prefix: %diagn_ restricts the compile-time log level to Prefixed [||], does not change tighter settings (Nothing, Prefixed [|prefixes...|]).
• forget_printbox
• snapshot in the PrintBox backend as in #21.
• Optionally, snapshot () at the end of a log_value call if elapsed time since last snapshot is greater than given threshold.
• A replacement Minidebug_runtime.sexp_of_lazy_t that does not force the thunk (but prints content if available).
• A new extension point [%log_result] to convey information in a header.
• A new extension point [%log_printbox] that directly embeds a PrintBox.t in the logs, instead of a representation of it. A corresponding log_value_printbox entry in Minidebug_runtime.Debug_runtime.
• A new registered extension point [%%global_debug_log_level_from_env_var "env_var_name"].

Changed

• Re-interpret Prefixed [||] and Prefixed_or_result [||] to mean "explicit logs only" -- originally (as logic indicates) it was equivalent to Nothing.
• Change runtime Prefixed_or_result to only output results if an entry would be non-empty without them.
• Breaking change: removed the Pp_format backend.
• More informative headers for tracking: e.g. anonymous functions logged with fun:file_name:LNUM instead of __fun.
• When printing sexps, don't escape strings for box-level atoms, print them directly. This can be disabled by setting sexp_unescape_strings to false.
• A more configurable debug_flushing builder.
• max_inline_sexp_length is now configurable via a debug_file call, and the default is bumped to 80.

Fixed

• Be more defensive about not allowing multiline descriptions and messages.
• Don't output line breaks in time-tagged headers.
• Be more consistent about when entries are opened: open toplevel (extension-point) entries even if not binding anything; don't open nested entries when restricted to explicit logs.
• Nested structure items are not toplevel extension points (fix over-generating log entries e.g. for other ppx extensions).

[1.2.1] -- 2024-02-15

Added

• Optionally print entry_ids for log headers (and escaping logs).

Fixed

• Do not crash when logging value with an empty entry stack; while unusual, "logs escaping lexical scope" are fine.

[1.2.0] -- 2024-02-14

Added

• Runtime log levels for the PrintBox backend.
• Compile-time log levels.

Changed

• %debug_ entry points log un-annotated functions but only the function the entry point is attached to.
• Added a default type string to %log expression decomposition, reducing the need for annotations.

Fixed

• _rt_ & _rtb_ should work even when nested inside another debug scope.
  • Nested entry extension point is still considered toplevel.
• Tighter error locations for %log missing types or type errors.

[1.1.0] -- 2024-02-11

Added

• A shared runtime-wide setting global_prefix for prefixing log headers (and closing tags in the flushing backend), to disambiguate (or debug) interactions of different runtime instances.
• _rt_ resp. _rtb_ (e.g. %track_rtb_sexp) entry points to support runtime-passing, i.e. abstracting over a Debug_runtime resp. PrintBox_runtime.
• An extension point %log that is not registered -- therefore reducing interference with logger ppxs -- and does not open a new log subtree.
• Optionally indicate elapsed time in subtree headers in the PrintBox backend.

Changed

• Removed the VS Code specific section of the README.
• Slightly breaking change: the ~descr parameter of the logging functions in the runtimes is now optional.

Fixed

• log_value_pp would raise a potentially uncaught or misleading exception, now marks a syntax error.
• Setting of the global log_value was not updated for nested extension points.

[1.0.0] -- 2024-02-03

Added

• PrintBox Markdown backend.
• Optionally, log to multiple files, opening a new file once a file size threshold is exceeded.
• Continuous Integration tests.
• Fixes #9: handle tuple and record patterns.
• Handle variants patterns, nested patterns, ... pretty much all patterns.
• Log bindings in match and function patterns, but only when in a %track_ scope.
• Provide pattern text in addition to the branch number (counted from 0).
• Propagate type information top-down and merge different sources of type information.
• Optionally, log the type information found with extension points %debug_type_info and %global_debug_type_info.
• A PrintBox-backend option truncate_children to limit the amount of output.

Changed

• Rename debug_html to debug_file, since it now supports both HTML and Markdown. Take file name/path without a suffix.
• Refactored PrintBox configuration, smaller footprint and allowing control over the backends.
• Changed highlighted_roots to a more general prune_upto: prune to only the highlighted boxes up to the given depth.
• Exported PrintBox_runtime configuration for better flexibility (in-flight configuration changes).
• Refactored the optional termination configuration max_nesting_depth and max_num_children into extension points %debug_interrupts and %global_debug_interrupts.

Fixed

• In values_first_mode, be consistent about what counts as a returned value.
• Missing transformations for %debug_notrace, and generally for the root construct of a body of a non-logged binding.

[0.9.0] -- 2024-01-18

Added

• Optionally output source locations as hyperlinks -- requires a (potentially empty) address prefix.
• A setting values_first_mode for the PrintBox runtime, to put results of computation as headers, and push paths beneath headers (friendly for HTML-backed foldable output).

Changed

• Include the variable name in the open-log line (just as function name for functions).
• Output the description of a for loop body as <for [identifier]> rather than just [identifier].
• Debug_runtime functions now take an ~entry_id parameter, set to a per-entry ID generated by get_entry_id.
• Small non-atomic sexp values can now be printed inline with the variable name (like sexp atoms) rather than spread out as trees.

[0.8.0] -- 2024-01-16

Added

• When in an active %track_ scope:
  • Log for loop nesting and indices at the beginning of a loop body.
  • Log while loop nesting.
  • Log function branches (similar to match branches).
  • Log all functions. Doing it only for %track_ to reduce noise.
    • This will log type-annotated arguments of anonymous functions (even when the function result type is not annotated).

[0.7.0] -- 2023-12-31

Added

• A new optional PrintBox-only setting highlight_terms, which applies a frame / border on paths to leaves matching a regular expression.
  • A corresponding setting exclude_on_path -- if this regular expression matches on a log, its children have no effect on its highlight status. I.e., exclude_on_path stops the continued propagation of highlights.
  • A flag highlighted_roots prevents outputting toplevel boxes that have not been highlighted.
• A set of extension points %track_sexp, %track_pp etc. that parallel %debug_sexp, %debug_pp etc. but additionally log which if and match branch got executed.
  • An extension point %debug_notrace that turns off logging the branch of the specific if or match expression. It is ignored by the %debug_ extension points.

Fixed

• Issue #8: ignore nested debug scope indications (don't re-process them).

[0.6.2] -- 2023-12-21

Fixed

• Backward compatibility: Out_channel.output_string --> Stdlib.output_string.

[0.6.1] -- 2023-12-20

Support for debugging infinite loops.

Added

• A new optional setting max_num_children, which terminates a computation with a Failure exception when the given size of sibling logs is exceeded.

[0.6.0] -- 2023-12-15

Added

• Runtime entry point debug_flushing that returns a Flushing runtime which by default logs to stdout.
• A new optional setting max_nesting_depth, which terminates a computation with a Failure exception when the given nesting of logs is exceeded.

[0.5.0] -- 2023-10-29

Added

• An option to output to HTML, when in the PrintBox runtime.
• An option to convert the logged sexp values to PrintBox trees, when they exceed a given size in atoms.
• Runtime entry points debug_html that returns a PrintBox runtime configured to output HTML into a file with the given name, and debug that returns a PrintBox runtime which by default logs to stdout.

Changed

• Exception handling that allows proper tracing/logging for raising functions and crashing (via uncaught exception) programs.

[0.4.0] -- 2023-10-18

Added

• The PrintBox logger now allows disabling (not outputting) a whole subtree of the logs.

Fixed

• A broken link in the documentation landing page.

[0.3.3] -- 2023-09-15

Changed

• Breaking change: explicitly set whether logs should be time tagged.

[0.3.2] -- 2023-04-25

Fixed

• Missing version bounds on ocaml and ppxlib to make CI happy.

[0.3.1] -- 2023-03-30

Fixed

• A small tweak to have dune-release work.

[0.3.0] -- 2023-03-29

Changed

• Breaking change: renamed Minidebug_runtime.Format to Minidebug_runtime.PP_format.
• Non-optionally depending on sexplib0 and ppx_sexp_conv, as optional dependency was making it hard to test. Also the minidebug_runtime source files duplication was ugly.
• Trying to minimize dependencies: removed the unused direct dependency on base, but ppx_sexp_conv depends on it. Removed the dependency on stdio.
• Added a building-related comment to the documentation.

[0.2.0] -- 2023-03-29

Fixed

• Added non-optional package dependencies.
• Major bug fix: missing processing of the top expression in a function body.

[0.1.4] -- 2023-03-21

Changed

• Merged the two packages ppx_minidebug and minidebug_runtime into one.

[0.1.3] -- 2023-03-17

Fixed

• Handles labeled function arguments.

Added

• Documentation suggestions regarding VOCaml.

[0.1.2] -- 2023-03-06

Added

• A syntax extension to instrument type-annotated bindings and functions with logging.
• The extension supports 3 value conversion mechanisms: pp and show from deriving.show, and sexp from ppx_sexp_conv.
• The minidebug_runtime package provides 3 logging backends: Format based purely on formatters, Flushing that converts to strings first and flushes output after every entry, and PrintBox that pretty-prints as trees using the printbox package.
• References a VS Code extension that builds flame graphs for the Flushing logger out-of-the-box.
• Documentation and API docs on github.io.
• Tests, including testing the writing-to-files functionality. Uses sed for sanitizing.