Sink (mavkit-libs.Mavryk_event_logging_test_helpers.Tezt

type t

A sink can store any required state, e.g. a database handle, in a value of the t type see configure.

val uri_scheme : string

Registered sinks are a distinguished by their URI scheme.

val configure : Uri.t -> t Mavryk_error_monad.Error_monad.tzresult Lwt.t

When a registered sink is activated the configure function is called to initialize it. The parameters should be encoded or obtained from the URI (the scheme of the URI is already uri_scheme).

val should_handle : 
  ?section:Mavryk_event_logging.Internal_event.Section.t ->
  t ->
  _ Mavryk_event_logging.Internal_event.event_definition ->
  bool

Predicate deciding whether a sink should handle the event or not.

val handle : 
  t ->
  'a Mavryk_event_logging.Internal_event.event_definition ->
  ?section:Mavryk_event_logging.Internal_event.Section.t ->
  'a ->
  unit Mavryk_error_monad.Error_monad.tzresult Lwt.t

A sink's main function is to handle incoming events from the code base.

val close : t -> unit Mavryk_error_monad.Error_monad.tzresult Lwt.t

A function to be called on graceful termination of processes (e.g. to flush file-descriptors, etc.).