package easy_logging

You can search for identifiers within the package.

in-package search v0.2.0

Module to log messages. Aimed at being both powerful and easy to use

Install

Dune Dependency

sapristi.github.io Readme Edit opam file Versions (11)

Authors

M

Mathias Millet

Maintainers

M

mathiasmillet@gmail.com

Sources

v0.8.1.tar.gz

md5=8d5dca598561d4922d20a00fade0a1da

sha512=f310cd2a9f3f64942baf32287267ddfe3212bcc5aa5a62c7b269809f586e2247d2d1adc4bd52cc3a9a7e6f769b9de090f8386a1bc764612ec91bf2a7d886ef0b

doc/easy_logging/Easy_logging/Handlers/index.html

Module `Easy_logging.Handlers`Source

This is the Handlers module. It provides simple yet adaptable handlers implementation.

Sourcetype log_formatter = Easy_logging__.Logging_types.log_item -> string

Type definitions

Sourcetype filter = Easy_logging__.Logging_types.log_item -> bool

Sourcetype t = {

mutable fmt : log_formatter;
mutable level : Easy_logging__.Logging_types.level;
mutable filters : filter list;
output : string -> unit;

}

Type of a handler

A handler is made of:

a formatter that transforms a log item into a string.
a level used to filter out items.
an array of possible additional custom filters.
an output function, that takes a string and does the output job.

Handlers creation helpers

Sourcemodule CliHandler : sig ... end

Module to create handlers that output to stdout or stderr.

Sourcemodule FileHandler : sig ... end

Module to create handlers that output to a file.

Sourcetype config = {

file_handlers : FileHandler.config;

}

Sourceval default_config : config

Sourcetype desc =

| Cli of Easy_logging__.Logging_types.level
| CliErr of Easy_logging__.Logging_types.level
| File of string * Easy_logging__.Logging_types.level
| RotatingFile of string * Easy_logging__.Logging_types.level * int * int

Sourceval make : ?config:config -> desc -> t

Used for quick handler creation, e.g.

Cli handler: outputs colored messages to stdout
```
 let h = Handlers.make (Cli Debug) 
```

File handler : outputs messages to a given file

 let h = Handlers.make (File ("filename", Debug))

Handlers setup

Sourceval set_level : t -> Easy_logging__.Logging_types.level -> unit

Sets the level of a handler.

Sourceval set_formatter : t -> log_formatter -> unit

Sets the formatter of a handler.

Sourceval add_filter : t -> filter -> unit

Adds a filter to a handler.

Sourceval apply : t -> Easy_logging__.Logging_types.log_item -> unit

Auxiliary function.

On This Page

Handlers creation helpers
Handlers setup