From 064e6e26bb459fd814b05da03e6cd2b49f618e52 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 13 Jan 2025 10:17:57 -0500 Subject: [PATCH] prepare for 0.9 --- CHANGES.md | 4 ++++ dune-project | 2 +- src/core/collector.ml | 2 +- src/core/trace_core.mli | 4 ++-- src/core/types.ml | 2 +- src/subscriber/callbacks.ml | 2 +- 6 files changed, 10 insertions(+), 6 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 2721a13..a563d37 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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 diff --git a/dune-project b/dune-project index 46a309c..8bdbe10 100644 --- a/dune-project +++ b/dune-project @@ -4,7 +4,7 @@ (generate_opam_files true) -(version 0.8) +(version 0.9) (source (github c-cube/ocaml-trace)) diff --git a/src/core/collector.ml b/src/core/collector.ml index 650b806..5fed60a 100644 --- a/src/core/collector.ml +++ b/src/core/collector.ml @@ -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. *) diff --git a/src/core/trace_core.mli b/src/core/trace_core.mli index b685a08..0af127e 100644 --- a/src/core/trace_core.mli +++ b/src/core/trace_core.mli @@ -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 *) diff --git a/src/core/types.ml b/src/core/types.ml index e4a2f10..04cee7b 100644 --- a/src/core/types.ml +++ b/src/core/types.ml @@ -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 *) diff --git a/src/subscriber/callbacks.ml b/src/subscriber/callbacks.ml index 4bca092..bac36b1 100644 --- a/src/subscriber/callbacks.ml +++ b/src/subscriber/callbacks.ml @@ -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)