package vlt

All checked builds pass
  1. Overview
  2. Docs
A variant of Bolt logging tool

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v0.2.5.tar.gz
sha256=756a6cba94204cda45ee767ca5f7e52ec321873dd53de48025c32dba1e03de24
md5=c0f22efcafa1119a9c82ffd9d7422da2

Description

Vlt is yet another variant of Bolt logging tool derived from Volt. Unlike Volt, Vlt relies on ppx instead of camlp4 to preprocess source code.

Tags

logging

Added to opam-repository:

README

VLT - A Variant of Bolt OCaml Logging Tool

Overview

This package provides yet another variant of Bolt OCaml logging tool called VLT derived from Volt 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_seq end | begin%error_block expr_seq end | begin%warn_block expr_seq end | begin%info_block expr_seq end | begin%debug_block expr_seq end | begin%trace_block expr_seq end

  • 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 from GitHub.

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 is here.


Copyright © 2023 Codinuum Software Lab

Dependencies (4)

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

Dev Dependencies (2)

  1. odoc with-doc
  2. ocamlfind with-test

Optional Dependencies

None

Conflicts (1)

  1. ppxlib = "0.37.0~5.4preview"

Build status

Results of building vlt with each compiler on check.ci.ocaml.org, run of against opam-repository 8d8d144. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.2.5 (this version) n/a good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure