package tezos-event-logging

You can search for identifiers within the package.

in-package search v0.2.0

tezos-event-logging
- Tezos_event_logging
  - Internal_event
    
    All_definitions
    
    All_sinks
    
    Debug_event
    
    EVENT
    
    EVENT_DEFINITION
    
    Error_event
    
    Generic
    
    Legacy_logging
    
    LOG
    
    Make
    
    Event
    
    _
    
    Make_semantic
    
    Event
    
    _
    
    SEMLOG
    
    Level
    
    Lwt_log_sink
    
    Lwt_worker_event
    
    Make
    
    E
    
    SINK
    
    Section
    
    Simple

Legend:
Library
Module
Module type
Parameter
Class
Class type

Error_event.t is a generic event to emit values of type Error_monad.errorlist.

type t = {

message : string option;
severity : [ `Fatal | `Recoverable ];
trace : Tezos_error_monad.Error_monad.error list;

}

Errors mainly store Error_monad.errorlist values. One can attach a message and a severity (the default is `Recoverable which corresponds to the Error level, while `Fatal corresponds to Fatal).

val make : 
  ?message:string ->
  ?severity:[ `Fatal | `Recoverable ] ->
  Tezos_error_monad.Error_monad.error list ->
  unit ->
  t

include EVENT with type t := t

include EVENT_DEFINITION with type t := t

val section : Section.t option

Defines an optional section for the event.

Warning None is only for legacy events and should not be used in new code.

val name : string

Defines the identifier for the event. Names should be unique and are restricted to alphanumeric characters or ".@-_+=,~".

val doc : string

A display-friendly text which describes what the event means.

val pp : short:bool -> Format.formatter -> t -> unit

val encoding : t Data_encoding.t

val level : t -> level

Return the preferred level for a given event instance.

val emit : 
  ?section:Section.t ->
  (unit -> t) ->
  unit Tezos_error_monad.Error_monad.tzresult Lwt.t

Output an event of type t, if no sinks are listening the function won't be applied.

val log_error_and_recover : 
  ?section:Section.t ->
  ?message:string ->
  ?severity:[ `Fatal | `Recoverable ] ->
  (unit -> (unit, Tezos_error_monad.Error_monad.error list) result Lwt.t) ->
  unit Lwt.t

log_error_and_recover f calls f () and emits an Error_event.t event if it results in an error. It then continues in the _ Lwt.t monad (e.g. there is no call to Lwt.fail).