prepare for 0.9

This commit is contained in:
Simon Cruanes 2025-01-13 10:17:57 -05:00
parent 4dfa319003
commit 064e6e26bb
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
6 changed files with 10 additions and 6 deletions

View file

@ -1,3 +1,7 @@
# 0.9
- add an extensible sum type, so users can implement custom events. For example
an OTEL collector can provide custom events to link two spans to one another.
# 0.8

View file

@ -4,7 +4,7 @@
(generate_opam_files true)
(version 0.8)
(version 0.9)
(source
(github c-cube/ocaml-trace))

View file

@ -98,7 +98,7 @@ module type S = sig
(** Handle an extension event.
A collector {b MUST} simple ignore events it doesn't know,
and return [()] silently.
@since NEXT_RELEASE *)
@since 0.8 *)
val shutdown : unit -> unit
(** Shutdown collector, possibly waiting for it to finish sending data. *)

View file

@ -219,11 +219,11 @@ val shutdown : unit -> unit
type extension_event = Types.extension_event = ..
(** Extension event
@since NEXT_RELEASE *)
@since 0.8 *)
val extension_event : extension_event -> unit
(** Trigger an extension event, whose meaning depends on
the library that defines it. Some collectors will
simply ignore it. This does nothing if no collector
is setup.
@since NEXT_RELEASE *)
@since 0.8 *)

View file

@ -27,4 +27,4 @@ type explicit_span = {
type extension_event = ..
(** An extension event, used to add features that are backend specific
or simply not envisioned by [trace].
@since NEXT_RELEASE *)
@since 0.8 *)

View file

@ -108,7 +108,7 @@ module type S = sig
val on_extension_event :
st -> time_ns:float -> tid:int -> extension_event -> unit
(** Extension event
@since NEXT_RELEASE *)
@since 0.8 *)
end
type 'st t = (module S with type st = 'st)