package easy_logging

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Type definitions
Formatting functions
Handlers creation helpers
Handlers setup

easy_logging
- Easy_logging
  - Handlers
  - Logging
    
    HandlersT
    
    logger
  - MakeLogging
    
    H
    
    HandlersT
    
    logger

Legend:
Library
Module
Module type
Parameter
Class
Class type

Default implementation of a Handlers module.

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

Type definitions

type tag = string

type log_item = {

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

}

type log_formatter = log_item -> string

type filter = log_item -> bool

type 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

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

val format_tags : string list -> string

Auxiliary functions.

val format_default : log_item -> string

Human readable log messages.

val format_color : log_item -> string

Human readable log messages, with level depending colors.

val format_json : log_item -> string

JSON logs for software interoperability.

Handlers creation helpers

type file_handlers_config = {

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

}

val file_handlers_defaults : file_handlers_config

type config = {

mutable file_handlers : file_handlers_config;

}

val config : config

val set_config : config -> unit

Sets how log files are created when using make_file_handler

val make_cli_handler : Easy_logging__.Easy_logging_types.level -> t

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

type desc

val 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

val set_level : t -> Easy_logging__.Easy_logging_types.level -> unit

Sets the level of a handler.

val set_formatter : t -> log_formatter -> unit

Sets the formatter of a handler.

val add_filter : t -> filter -> unit

Adds a filter to a handler.

val apply : t -> log_item -> unit

Auxiliary function.