Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.81 KB

README.md

File metadata and controls

57 lines (37 loc) · 1.81 KB

Logs — Logging infrastructure for OCaml

%%VERSION%%

Logs provides a logging infrastructure for OCaml. Logging is performed on sources whose reporting level can be set independently. Log message report is decoupled from logging and is handled by a reporter.

A few optional log reporters are distributed with the base library and the API easily allows to implement your own.

Logs has no dependencies. The optional Logs_fmt reporter on OCaml formatters depends on Fmt. The optional Logs_browser reporter that reports to the web browser console depends on js_of_ocaml. The optional Logs_cli library that provides command line support for controlling Logs depends on Cmdliner. The optional Logs_lwt library that provides Lwt logging functions depends on Lwt

Logs and its reporters are distributed under the ISC license.

Home page: http://erratique.ch/software/logs

Installation

Logs can be installed with opam:

opam install logs
opam install fmt cmdliner lwt js_of_ocaml logs # Install all opt libraries

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation can be consulted online or via odig doc logs.

Questions are welcome but better asked on the OCaml forum than on the issue tracker.

Sample programs

If you installed Logs with opam sample programs are located in the directory opam config var logs:doc.