Using The Event Logging Framework

Developers of most modules should consider generating useful information for the Logging subsystem.

In the Octez code base, logging is instrumented using an asynchronous event system, where log events are emitted in various part of the code and consumed by the so called sinks. This is done by using the tezos-event-logging library.

We use two levels of abstraction to define these events. Heavy events are defined using the most generic API and have the full expressive power and structure. Simple events are record-like structures which are constructed on top of the generic event api, and are meant to be less verbose and more developer friendly.

Adding Events

Simple Events

Simple events are record-like structures which are constructed directly (i.e. there is no high-level OCaml type, and parsing events is not accessible programmatically). The API is less generic than the “Heavy” Events’.

See for instance src/lib_node_config/ (search for the string declare_):

  • one declares typed-record events with Internal_event.Simple.declare_<number-of-fields>,

  • and they are called with val Simple.emit: 'a Simple.t -> 'a -> (unit, trace) result Lwt.t.

Please read the guidelines that are documented in the Internal_event.Simple module.

“Heavy” Events

The most generic API for defining events Internal_event.Make gives full expressive power and structure.

See for instance: src/proto_alpha/lib_delegate/ (module Block_seen_event):

  • one needs to call the functor module Event = Internal_event.Make(Definition) where Definition: Internal_event.EVENT_DEFINITION;

  • this provides val Event.emit: ?section:Section.t -> Block_seen_event.t -> (unit, trace) result Lwt.t.

Creating Sinks

A sink is a module of type Internal_event.SINK which is registered within the system (just like events or errors kinds) using: let () = Internal_event.All_sinks.register (module My_sink). Its chosen URI-scheme should be unique.

See for instance: