Batch (opentelemetry.Opentelemetry

type 'a t

val make : 
  ?batch:int ->
  ?high_watermark:int ->
  ?now:Mtime.t ->
  ?timeout:Mtime.span ->
  unit ->
  'a t

make () is a new batch

parameter batch
the number of elements after which the batch will be considered full, and ready to pop. Set to 0 to disable batching. It is required that batch >= 0. Default 1.

parameter high_watermark
the batch size limit after which new elements will be `Dropped by push. This prevents the queue from growing too fast for effective transmission in case of signal floods. Default if batch = 1 then 100 else batch * 10.

parameter now
the current time. Default Mtime_clock.now ().

parameter timeout
the time span after which a batch is ready to pop, whether or not it is full.

val pop_if_ready : ?force:bool -> now:Mtime.t -> 'a t -> 'a list option

pop_if_ready ~now b is Some xs, where is xs includes all the elements pushed since the last batch, if the batch ready to be emitted.

A batch is ready to pop if it contains some elements and

batching is disabled, and any elements have been batched, or batching was enabled and at least batch elements have been pushed, or
a timeout was provided, and more than a timeout span has passed since the last pop was ready, or
the pop is forced,

parameter now
the current time

parameter force
override the other batch conditions, for when when we just want to emit batches before exit or because the user asks for it

val push : 'a t -> 'a list -> [ `Dropped | `Ok ]

push b xs is `Ok if it succeeds in pushing the values in xs into the batch b, or `Dropped if the current size of the batch has exceeded the high water mark determined by the batch argument to make]. )