Ambient_contextmodule TLS = Ambient_context_thread_local.Thread_localmodule Hmap = Ambient_context_core.Ambient_context_hmapmodule Atomic = Ambient_context_atomic.Atomicinclude module type of struct include Ambient_context_core.Types endmodule Hmap := Ambient_context_core.Ambient_context_hmapmodule type STORAGE = Ambient_context_core.Types.STORAGEtype storage = (module STORAGE)type 'a key = int * 'a Hmap.keyval id : int Atomic.tval default_storage : Ambient_context_core.Types.storageval get_current_storage : unit -> Ambient_context_core.Types.storageval create_key : unit -> int * 'a Ambient_context_core.Ambient_context_hmap.keyval get : (int * 'a Ambient_context_core.Ambient_context_hmap.key) -> 'a optionval with_binding : 'a key -> 'a -> (unit -> 'r) -> 'rval without_binding :
- (int * 'a Ambient_context_core.Ambient_context_hmap.key) ->
- (unit -> 'b) ->
- 'cval set_storage_provider : Ambient_context_core.Types.storage -> unitAmbient_context__ambient_context_unix__This module is hidden.
Ambient_context_atomic.AtomicAtomic references.
type 'a t = 'a Stdlib.Atomic.tAn atomic (mutable) reference to a value of type 'a.
val make : 'a -> 'a tCreate an atomic reference.
val get : 'a t -> 'aGet the current value of the atomic reference.
val set : 'a t -> 'a -> unitSet a new value for the atomic reference.
val exchange : 'a t -> 'a -> 'aSet a new value for the atomic reference, and return the current value.
val compare_and_set : 'a t -> 'a -> 'a -> boolcompare_and_set r seen v sets the new value of r to v only if its current value is physically equal to seen -- the comparison and the set occur atomically. Returns true if the comparison succeeded (so the set happened) and false otherwise.
val fetch_and_add : int t -> int -> intfetch_and_add r n atomically increments the value of r by n, and returns the current value (before the increment).
val incr : int t -> unitincr r atomically increments the value of r by 1.
val decr : int t -> unitdecr r atomically decrements the value of r by 1.
Ambient_context_atomicmodule Atomic : sig ... endAtomic references.
Ambient_context_core.Ambient_context_hmapinclude module type of struct include Hmap endtype 'a key = 'a Hmap.keyThe type for keys whose lookup value is of type 'a.
module Key = Hmap.KeyKeys.
type t = Hmap.tThe type for heterogeneous value maps.
val empty : tempty is the empty map.
val is_empty : t -> boolis_empty m is true iff m is empty.
The type for bindings.
fold f m acc folds over the bindings of m with f, starting with acc
exists p m is true iff there exists a bindings of m that satisfies p.
val cardinal : t -> intcardinal m is the number of bindings in m.
The functorial interface allows to associate more information to the keys. For example a key name or a key value pretty-printer.
module type KEY_INFO = Hmap.KEY_INFOThe type for key information.
module Make = Hmap.MakeFunctor for heterogeneous maps whose keys hold information of type Key_info.t
Ambient_context_core.Typesmodule Hmap := Ambient_context_hmaptype 'a key = 'a Hmap.keymodule type STORAGE = sig ... endtype storage = (module STORAGE)Types.STORAGEval get_map : unit -> Hmap.t optionval with_map : Hmap.t -> (unit -> 'b) -> 'bval create_key : unit -> 'a keyval get : 'a key -> 'a optionval with_binding : 'a key -> 'a -> (unit -> 'b) -> 'bval without_binding : 'a key -> (unit -> 'b) -> 'bAmbient_context_coremodule Ambient_context_hmap : sig ... endmodule Types : sig ... endAmbient_context_core__Ambient_context_hmapThis module is hidden.
Ambient_context_core__TypesThis module is hidden.
Ambient_context_thread_local.Thread_localThread/Domain local storage
This allows the creation of global state that is per-domain or per-thread.
val create : unit -> 'a tCreate new storage
val get : 'a t -> 'a optionGet current value
val set : 'a t -> 'a -> unitval remove : _ t -> unitval get_or_create : create:(unit -> 'a) -> 'a t -> 'aval with_ : 'a t -> 'a -> ('a option -> 'b) -> 'bwith_ var x f sets var to x for this thread, calls f prev where prev is the value currently in var (if any), and then restores the old value of var for this thread.
Ambient_context_thread_localmodule Thread_local : sig ... endThread/Domain local storage
Ambient_context_thread_local__Thread_localThis module is hidden.
Ambient_context_tls.Mval get_map : unit -> Hmap.t optionval with_map : Hmap.t -> (unit -> 'a) -> 'bval create_key : unit -> 'a Hmap.keyval get : 'a Hmap.key -> 'b optionval with_binding : 'a Hmap.key -> 'b -> (unit -> 'c) -> 'dval without_binding : 'a Hmap.key -> (unit -> 'b) -> 'cAmbient_context_tlsmodule TLS = Ambient_context_thread_local.Thread_localmodule Hmap = Ambient_context_core.Ambient_context_hmapmodule M : sig ... endval storage : unit -> Ambient_context_core.Types.storageBrowse by name, by tag, the standard library and the OCaml manual (online, latest version).
Generated for /home/runner/work/ocaml-opentelemetry/ocaml-opentelemetry/_opam/lib
Browse by name, by tag, the standard library and the OCaml manual (online, latest version).
Generated for /home/runner/work/ocaml-opentelemetry/ocaml-opentelemetry/_opam/lib
Opentelemetry_client_ocurl.ConfigConfiguration for the ocurl backend
type t = private {debug : bool;url : string;Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.
*)headers : (string * string) list;API headers sent to the endpoint. Default is none or "OTEL_EXPORTER_OTLP_HEADERS" if set.
*)batch_timeout_ms : int;Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs or when a tick is emitted. Default 2_000.
*)bg_threads : int;Are there background threads, and how many? Default 4. This will be adjusted to be at least 1 and at most 32.
ticker_thread : bool;If true, start a thread that regularly checks if signals should be sent to the collector. Default true
ticker_interval_ms : int;Interval for ticker thread, in milliseconds. This is only useful if ticker_thread is true. This will be clamped between 2 ms and some longer interval (maximum 60s currently). Default 500.
self_trace : bool;If true, the OTEL library will also emit its own spans. Default false.
}Configuration.
To build one, use make below. This might be extended with more fields in the future.
val make :
+Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config) Module Opentelemetry_client_ocurl.Config
Configuration for the ocurl backend
type t = private {debug : bool;url_traces : string;(*Url to send traces
*)url_metrics : string;(*Url to send metrics
*)url_logs : string;(*Url to send logs
*)headers : (string * string) list;(*API headers sent to the endpoint. Default is none or "OTEL_EXPORTER_OTLP_HEADERS" if set.
*)batch_timeout_ms : int;(*Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs or when a tick is emitted. Default 2_000.
*)bg_threads : int;(*Are there background threads, and how many? Default 4. This will be adjusted to be at least 1 and at most 32.
*)ticker_thread : bool;(*If true, start a thread that regularly checks if signals should be sent to the collector. Default true
*)ticker_interval_ms : int;(*Interval for ticker thread, in milliseconds. This is only useful if ticker_thread is true. This will be clamped between 2 ms and some longer interval (maximum 60s currently). Default 500.
*)self_trace : bool;(*If true, the OTEL library will also emit its own spans. Default false.
*)
}Configuration.
To build one, use make below. This might be extended with more fields in the future.
val make :
?debug:bool ->
?url:string ->
+ ?url_traces:string ->
+ ?url_metrics:string ->
+ ?url_logs:string ->
?headers:(string * string) list ->
?batch_timeout_ms:int ->
?bg_threads:int ->
@@ -9,4 +12,4 @@
?ticker_interval_ms:int ->
?self_trace:bool ->
unit ->
- tMake a configuration.
val pp : Stdlib.Format.formatter -> t -> unit
+ tMake a configuration.
val pp : Stdlib.Format.formatter -> t -> unitOpentelemetry_client_ocurlUrl of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.
Set http headers that are sent on every http query to the collector.
module Atomic = Opentelemetry_atomic.Atomicmodule Config : sig ... endConfiguration for the ocurl backend
val create_backend :
+Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl) Module Opentelemetry_client_ocurl
Set http headers that are sent on every http query to the collector.
module Atomic = Opentelemetry_atomic.Atomicmodule Config : sig ... endConfiguration for the ocurl backend
val create_backend :
?stop:bool Atomic.t ->
?config:Config.t ->
unit ->
diff --git a/opentelemetry-client-ocurl/_doc-dir/CHANGES.md b/opentelemetry-client-ocurl/_doc-dir/CHANGES.md
index 9df8f742..471daf64 100644
--- a/opentelemetry-client-ocurl/_doc-dir/CHANGES.md
+++ b/opentelemetry-client-ocurl/_doc-dir/CHANGES.md
@@ -1,4 +1,10 @@
+## 0.10
+
+- feat: add support for per-signal urls (by @tatchi)
+- build: disable protobuf regeneration during normal library use
+- fix: emit GC metrics even in the absence of custom metrics
+
## 0.9
- compat with trace 0.7
diff --git a/opentelemetry-cohttp-lwt/_doc-dir/CHANGES.md b/opentelemetry-cohttp-lwt/_doc-dir/CHANGES.md
index 9df8f742..471daf64 100644
--- a/opentelemetry-cohttp-lwt/_doc-dir/CHANGES.md
+++ b/opentelemetry-cohttp-lwt/_doc-dir/CHANGES.md
@@ -1,4 +1,10 @@
+## 0.10
+
+- feat: add support for per-signal urls (by @tatchi)
+- build: disable protobuf regeneration during normal library use
+- fix: emit GC metrics even in the absence of custom metrics
+
## 0.9
- compat with trace 0.7
diff --git a/opentelemetry-lwt/Opentelemetry_lwt/Trace/index.html b/opentelemetry-lwt/Opentelemetry_lwt/Trace/index.html
index f9a1ae96..cf5e9976 100644
--- a/opentelemetry-lwt/Opentelemetry_lwt/Trace/index.html
+++ b/opentelemetry-lwt/Opentelemetry_lwt/Trace/index.html
@@ -42,7 +42,7 @@
(unit ->
'b)
* ((unit, string * Stdlib.Printexc.raw_backtrace) result ->
- unit)Sync span guard.
Notably, this includes implicit scope-tracking: if called without a ~scope argument (or ~parent/~trace_id), it will check in the Ambient_context for a surrounding environment, and use that as the scope. Similarly, it uses Scope.with_ambient_scope to set a new scope in the ambient context, so that any logically-nested calls to with_ will use this span as their parent.
NOTE be careful not to call this inside a Gc alarm, as it can cause deadlocks.
Sync span guard.
Notably, this includes implicit scope-tracking: if called without a ~scope argument (or ~parent/~trace_id), it will check in the Ambient_context for a surrounding environment, and use that as the scope. Similarly, it uses Scope.with_ambient_scope to set a new scope in the ambient context, so that any logically-nested calls to with_ will use this span as their parent.
NOTE be careful not to call this inside a Gc alarm, as it can cause deadlocks.
val with_ :
?force_new_trace_id:bool ->
?trace_state:string ->
?service_name:string ->
diff --git a/opentelemetry-lwt/_doc-dir/CHANGES.md b/opentelemetry-lwt/_doc-dir/CHANGES.md
index 9df8f742..471daf64 100644
--- a/opentelemetry-lwt/_doc-dir/CHANGES.md
+++ b/opentelemetry-lwt/_doc-dir/CHANGES.md
@@ -1,4 +1,10 @@
+## 0.10
+
+- feat: add support for per-signal urls (by @tatchi)
+- build: disable protobuf regeneration during normal library use
+- fix: emit GC metrics even in the absence of custom metrics
+
## 0.9
- compat with trace 0.7
diff --git a/opentelemetry/Opentelemetry/Conventions/Attributes/Host/index.html b/opentelemetry/Opentelemetry/Conventions/Attributes/Host/index.html
new file mode 100644
index 00000000..90b22c99
--- /dev/null
+++ b/opentelemetry/Opentelemetry/Conventions/Attributes/Host/index.html
@@ -0,0 +1,2 @@
+
+Host (opentelemetry.Opentelemetry.Conventions.Attributes.Host) Module Attributes.Host
https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/host.md
Attributes (opentelemetry.Opentelemetry.Conventions.Attributes) Module Conventions.Attributes
module Process : sig ... endmodule Code : sig ... endhttps://opentelemetry.io/docs/specs/semconv/attributes-registry/code/
module Service : sig ... endmodule HTTP : sig ... end
+Attributes (opentelemetry.Opentelemetry.Conventions.Attributes) Module Conventions.Attributes
module Process : sig ... endmodule Code : sig ... endhttps://opentelemetry.io/docs/specs/semconv/attributes-registry/code/
module Service : sig ... endmodule HTTP : sig ... endmodule Host : sig ... endhttps://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/host.md
diff --git a/opentelemetry/Opentelemetry/Scope/index.html b/opentelemetry/Opentelemetry/Scope/index.html
index b0fca4fb..493c16c7 100644
--- a/opentelemetry/Opentelemetry/Scope/index.html
+++ b/opentelemetry/Opentelemetry/Scope/index.html
@@ -1,2 +1,2 @@
-Scope (opentelemetry.Opentelemetry.Scope) Module Opentelemetry.Scope
Scopes.
A scope is a trace ID and the span ID of the currently active span.
type t = {trace_id : Trace_id.t;span_id : Span_id.t;mutable events : Event.t list;mutable attrs : key_value list;
}val to_span_ctx : t -> Span_ctx.tTurn the scope into a span context
Add an event to the scope. It will be aggregated into the span.
Note that this takes a function that produces an event, and will only call it if there is an instrumentation backend.
Add an attr to the scope. It will be aggregated into the span.
Note that this takes a function that produces attributes, and will only call it if there is an instrumentation backend.
val ambient_scope_key : t Ambient_context.keyThe opaque key necessary to access/set the ambient scope with Ambient_context.
Obtain current scope from Ambient_context, if available.
val with_ambient_scope : t -> (unit -> 'a) -> 'a0with_ambient_scope sc thunk calls thunk() in a context where sc is the (thread|continuation)-local scope, then reverts to the previous local scope, if any.
+Scope (opentelemetry.Opentelemetry.Scope) Module Opentelemetry.Scope
Scopes.
A scope is a trace ID and the span ID of the currently active span.
type t = {trace_id : Trace_id.t;span_id : Span_id.t;mutable events : Event.t list;mutable attrs : key_value list;
}val to_span_ctx : t -> Span_ctx.tTurn the scope into a span context
Add an event to the scope. It will be aggregated into the span.
Note that this takes a function that produces an event, and will only call it if there is an instrumentation backend.
Add an attr to the scope. It will be aggregated into the span.
Note that this takes a function that produces attributes, and will only call it if there is an instrumentation backend.
val ambient_scope_key : t {Ambient_context}2.keyThe opaque key necessary to access/set the ambient scope with Ambient_context.
Obtain current scope from Ambient_context, if available.
val with_ambient_scope : t -> (unit -> 'a) -> 'a0with_ambient_scope sc thunk calls thunk() in a context where sc is the (thread|continuation)-local scope, then reverts to the previous local scope, if any.
diff --git a/opentelemetry/Opentelemetry/Trace/index.html b/opentelemetry/Opentelemetry/Trace/index.html
index 1e99043a..801fb713 100644
--- a/opentelemetry/Opentelemetry/Trace/index.html
+++ b/opentelemetry/Opentelemetry/Trace/index.html
@@ -36,7 +36,7 @@
(unit ->
'b)
* ((unit, string * Stdlib.Printexc.raw_backtrace) result ->
- unit)Sync span guard.
Notably, this includes implicit scope-tracking: if called without a ~scope argument (or ~parent/~trace_id), it will check in the Ambient_context for a surrounding environment, and use that as the scope. Similarly, it uses Scope.with_ambient_scope to set a new scope in the ambient context, so that any logically-nested calls to with_ will use this span as their parent.
NOTE be careful not to call this inside a Gc alarm, as it can cause deadlocks.
Sync span guard.
Notably, this includes implicit scope-tracking: if called without a ~scope argument (or ~parent/~trace_id), it will check in the Ambient_context for a surrounding environment, and use that as the scope. Similarly, it uses Scope.with_ambient_scope to set a new scope in the ambient context, so that any logically-nested calls to with_ will use this span as their parent.
NOTE be careful not to call this inside a Gc alarm, as it can cause deadlocks.
val with_ :
?force_new_trace_id:bool ->
?trace_state:string ->
?service_name:string ->
diff --git a/opentelemetry/Opentelemetry_ambient_context/index.html b/opentelemetry/Opentelemetry_ambient_context/index.html
new file mode 100644
index 00000000..d66deace
--- /dev/null
+++ b/opentelemetry/Opentelemetry_ambient_context/index.html
@@ -0,0 +1,2 @@
+
+Opentelemetry_ambient_context (opentelemetry.Opentelemetry_ambient_context) Module Opentelemetry_ambient_context
Ambient context.
The ambient context, like the Matrix, is everywhere around you.
It is responsible for keeping track of that context in a manner that's consistent with the program's choice of control flow paradigm:
- for synchronous/threaded/direct style code, TLS ("thread local storage") keeps track of a global variable per thread. Each thread has its own copy of the variable and updates it independently of other threads.
- for Lwt, any
'a Lwt.t created inside the with_binding k v (fun _ -> …) will inherit the k := v assignment.
- for Eio, fibers created inside
with_binding k v (fun () -> …) will inherit the k := v assignment. This is consistent with the structured concurrency approach of Eio.
The only data stored by this storage is a Hmap.t, ie a heterogeneous map. Various users (libraries, user code, etc.) can create their own key to store what they are interested in, without affecting other parts of the storage.
module Types := Opentelemetry_ambient_context_typesmodule type STORAGE = Types.STORAGEtype storage = (module STORAGE)val default_storage : storageval get_current_storage : unit -> storageval set_storage_provider : storage -> unitval create_key : unit -> 'a keyCreate a new fresh key, distinct from any previously created key.
val get : 'a key -> 'a optionGet the current value for a given key, or None if no value was associated with the key in the ambient context.
val with_binding : 'a key -> 'a -> (unit -> 'r) -> 'rwith_binding k v cb calls cb() in a context in which k is bound to v. This does not affect storage outside of cb().
val without_binding : 'a key -> (unit -> 'b) -> 'bwithout_binding k cb calls cb() in a context where k has no binding (possibly shadowing the current ambient binding of k if it exists).
diff --git a/ambient-context/Ambient_context_atomic__Atomic/index.html b/opentelemetry/Opentelemetry_ambient_context__/index.html
similarity index 52%
rename from ambient-context/Ambient_context_atomic__Atomic/index.html
rename to opentelemetry/Opentelemetry_ambient_context__/index.html
index d66cde2c..51dcdfa7 100644
--- a/ambient-context/Ambient_context_atomic__Atomic/index.html
+++ b/opentelemetry/Opentelemetry_ambient_context__/index.html
@@ -1,2 +1,2 @@
-Ambient_context_atomic__Atomic (ambient-context.Ambient_context_atomic__Atomic) Module Ambient_context_atomic__Atomic
This module is hidden.
+Opentelemetry_ambient_context__ (opentelemetry.Opentelemetry_ambient_context__) Module Opentelemetry_ambient_context__
This module is hidden.
diff --git a/opentelemetry/Opentelemetry_ambient_context_lwt/index.html b/opentelemetry/Opentelemetry_ambient_context_lwt/index.html
new file mode 100644
index 00000000..27d7232f
--- /dev/null
+++ b/opentelemetry/Opentelemetry_ambient_context_lwt/index.html
@@ -0,0 +1,2 @@
+
+Opentelemetry_ambient_context_lwt (opentelemetry.Opentelemetry_ambient_context_lwt) Module Opentelemetry_ambient_context_lwt
val storage : unit -> Opentelemetry_ambient_context.storageStorage using Lwt keys
diff --git a/opentelemetry/Opentelemetry_ambient_context_types/index.html b/opentelemetry/Opentelemetry_ambient_context_types/index.html
new file mode 100644
index 00000000..ae3d6354
--- /dev/null
+++ b/opentelemetry/Opentelemetry_ambient_context_types/index.html
@@ -0,0 +1,2 @@
+
+Opentelemetry_ambient_context_types (opentelemetry.Opentelemetry_ambient_context_types) Module Opentelemetry_ambient_context_types
Storage implementation.
There is a singleton storage for a given program, responsible for providing ambient context to the rest of the program.
STORAGE (opentelemetry.Opentelemetry_ambient_context_types.STORAGE) Module type Opentelemetry_ambient_context_types.STORAGE
val get_map : unit -> Hmap.t optionGet the hmap from the current ambient context, or None if there is no ambient context.
val with_map : Hmap.t -> (unit -> 'b) -> 'bwith_hmap h cb calls cb() in an ambient context in which get_map() will return h. Once cb() returns, the storage is reset to its previous value.
val create_key : unit -> 'a keyCreate a new storage key, guaranteed to be distinct from any previously created key.
val get : 'a key -> 'a optionval with_binding : 'a key -> 'a -> (unit -> 'b) -> 'bval without_binding : 'a key -> (unit -> 'b) -> 'b
diff --git a/opentelemetry/_doc-dir/CHANGES.md b/opentelemetry/_doc-dir/CHANGES.md
index 9df8f742..471daf64 100644
--- a/opentelemetry/_doc-dir/CHANGES.md
+++ b/opentelemetry/_doc-dir/CHANGES.md
@@ -1,4 +1,10 @@
+## 0.10
+
+- feat: add support for per-signal urls (by @tatchi)
+- build: disable protobuf regeneration during normal library use
+- fix: emit GC metrics even in the absence of custom metrics
+
## 0.9
- compat with trace 0.7
diff --git a/opentelemetry/index.html b/opentelemetry/index.html
index e8bbec01..2cc8ed62 100644
--- a/opentelemetry/index.html
+++ b/opentelemetry/index.html
@@ -1,2 +1,2 @@
-index (opentelemetry.index) Package opentelemetry
Opentelemetry Opentelemetry types and instrumentationOpentelemetry_atomic Opentelemetry_proto
index (opentelemetry.index) Package opentelemetry
Opentelemetry Opentelemetry types and instrumentationOpentelemetry_ambient_context Ambient context.Opentelemetry_ambient_context_lwt Opentelemetry_ambient_context_types Storage implementation.Opentelemetry_atomic Opentelemetry_proto