Module `Easy_logging.Handlers`Source

Default implementation of a Handlers module.

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

Type definitions

Sourcetype tag = string

Sourcetype log_item = {

level : Easy_logging__.Easy_logging_types.level;
logger_name : string;
msg : string;
tags : string list;

}

Sourcetype log_formatter = log_item -> string

Sourcetype filter = log_item -> bool

Sourcetype t = {

mutable fmt : log_formatter;
mutable level : Easy_logging__.Easy_logging_types.level;
mutable filters : filter list;
output : out_channel;

}

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 out_channel, where log strings are outputed by the function Pervasives.output_string.

Formatting functions

Sourceval reduce : ('a -> 'a -> 'a) -> 'a list -> 'a -> 'a

Sourceval format_tags : string list -> string

Auxiliary functions.

Sourceval format_default : log_item -> string

Human readable log messages.

Sourceval format_color : log_item -> string

Human readable log messages, with level depending colors.

Sourceval format_json : log_item -> string

JSON logs for software interoperability.

Handlers creation helpers

Sourcetype file_handlers_config = {

logs_folder : string;
truncate : bool;
file_perms : int;

}

Sourceval file_handlers_defaults : file_handlers_config

Sourcetype config = {

mutable file_handlers : file_handlers_config;

}

Sourceval config : config

Sourceval set_config : config -> unit

Sets how log files are created when using make_file_handler

Sourceval make_cli_handler : Easy_logging__.Easy_logging_types.level -> t

Sourceval make_file_handler : Easy_logging__.Easy_logging_types.level -> string -> t

Sourcetype desc =

| Cli of Easy_logging__.Easy_logging_types.level
| File of string * Easy_logging__.Easy_logging_types.level

Sourceval make : 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__.Easy_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 -> log_item -> unit

Auxiliary function.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/easy_logging/Easy_logging/Handlers/index.html

Module `Easy_logging.Handlers`Source

Type definitions

Formatting functions

Handlers creation helpers

Handlers setup

package easy_logging

Install

Dune Dependency

Authors

Maintainers

Sources

doc/easy_logging/Easy_logging/Handlers/index.html

Module Easy_logging.HandlersSource

Type definitions

Formatting functions

Handlers creation helpers

Handlers setup

Module `Easy_logging.Handlers`Source