README

VLT - A Variant of Bolt OCaml Logging Tool

Overview

This package provides yet another variant ofBolt OCaml logging tool called VLT derived fromVolt logging tool. Unlike Volt, VLT relies on ppx instead of camlp4 to preprocess source code. In addition to the original Bolt (except preprocessor), VLT offers the following features:

• Pass filter concept Each logger has an associated pass filter, which ensures that events will never be propagated to the ancestor loggers when the events do not satisfy the filter.

• Original logging syntax modified for ppx
  log_expr ::=[%LOG level (string|ident) {arg}* {attr}*]

  level ::=
  |[%FATAL]
  |[%ERROR]
  |[%WARN]
  |[%INFO]
  |[%DEBUG]
  |[%TRACE]

  attr ::=
  |[%NAME string]
  |[%(PROPERTIES |WITH) expr]
  |[%(EXCEPTION |EXN) expr]

• Extended logging syntax
  log_expr ::= ...
  |[%fatal_log (string|ident) {arg}* {attr}*]
  |[%error_log (string|ident) {arg}* {attr}*]
  |[%warn_log (string|ident) {arg}* {attr}*]
  |[%info_log (string|ident) {arg}* {attr}*]
  |[%debug_log (string|ident) {arg}* {attr}*]
  |[%trace_log (string|ident) {arg}* {attr}*]

  block_expr ::=
  |begin%fatal_block expr_seqend
  |begin%error_block expr_seqend
  |begin%warn_block expr_seqend
  |begin%info_block expr_seqend
  |begin%debug_block expr_seqend
  |begin%trace_block expr_seqend

• More informative default logger name In addition to a capitalized source file name without suffix, surrounding module names, class names, method names, or function names are used to compute a logger name, unless[%NAME ...] attribute is provided. Note that, unlike Volt, you have to enclose each toplevel structure_item in[%%capture_path ...].

• Suppression of unwanted evaluation of arguments Arguments in the[%LOG ...] and *_log expressions are not evaluated when the defined logger does not record events.

• Additional keys for use by the pattern and csv layouts.
  monthname - name of month e.g. January, February, ...
  monthnm - abbreviated name of month e.g. Jan, Feb, ...

Sources

The development sources are available fromGitHub.

License

As in the original version, this tool is free software released under the LGPLv3.

Installation

$ dune build$ dune install

Original

The original Bolt is Copyright (C) 2009-2012 Xavier Clerc and released under the LGPLv3. The official website of Bolt ishere.

Copyright © 2023Codinuum Software Lab

1. cppobuild
2. ppxlib>= "0.29"
3. dune>= "3.7"
4. ocaml>= "4.14"

1. odocwith-doc
2. ocamlfindwith-test

1. diffast-api
2. diffast-cli
3. diffast-core
4. diffast-git
5. diffast-git-cli
6. diffast-langs-common
7. diffast-langs-cpp
8. diffast-langs-cpp-parsing
9. diffast-langs-cpp-spec
10. diffast-langs-fortran
11. diffast-langs-fortran-parsing
12. diffast-langs-fortran-spec
13. diffast-langs-java
14. diffast-langs-java-parsing
15. diffast-langs-java-spec
16. diffast-langs-python
17. diffast-langs-python-parsing
18. diffast-langs-python-spec
19. diffast-langs-verilog
20. diffast-langs-verilog-parsing
21. diffast-langs-verilog-spec
22. diffast-misc

None