simon/nanoev
1
0
Fork 0
mirror of https://github.com/c-cube/nanoev.git synced 2025-12-06 03:05:32 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: dc7f2ec92e

Browse source
This commit is contained in:
c-cube 2025-05-30 19:31:31 +00:00
parent a8b743ac01
commit b1694df407
26 changed files with 155 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
trace/Trace/index.html
View file

File diff suppressed because one or more lines are too long

2
trace/Trace_core/Collector/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (trace.Trace_core.Collector)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_core</a> &#x00BB; Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_core.Collector</span></code></h1><p>A global collector.</p><p>The collector, if present, is responsible for collecting messages and spans, and storing them, recording them, forward them, or offering them to other services and processes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_span"><a href="#val-dummy_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_span : int64</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_explicit_span"><a href="#val-dummy_explicit_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_explicit_span : <span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature for a collector.</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (trace.Trace_core.Collector)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_core</a> &#x00BB; Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_core.Collector</span></code></h1><p>A global collector.</p><p>The collector, if present, is responsible for collecting messages and spans, and storing them, recording them, forward them, or offering them to other services and processes.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_span"><a href="#val-dummy_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_span : int64</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_trace_id"><a href="#val-dummy_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> dummy_trace_id : string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_explicit_span"><a href="#val-dummy_explicit_span" class="anchor"></a><code><span><span class="keyword">val</span> dummy_explicit_span : <span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_explicit_span_ctx"><a href="#val-dummy_explicit_span_ctx" class="anchor"></a><code><span><span class="keyword">val</span> dummy_explicit_span_ctx : <span class="xref-unresolved">Trace_core__.Types.explicit_span_ctx</span></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Signature for a collector.</p></div></div></div></body></html>

6
trace/Trace_core/Collector/module-type-S/index.html
View file

@ -13,7 +13,7 @@
list</span> <span class="arrow">&#45;&gt;</span></span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span>int64 <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span>int64 <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Run the function in a new span.</p><p>This replaces the previous <code>enter_span</code> and <code>exit_span</code> which were too flexible to be efficient to implement in async contexts.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_span"><a href="#val-enter_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_span : <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Run the function in a new span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_span"><a href="#val-enter_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_span :
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span>
@ -27,7 +27,7 @@
list</span> <span class="arrow">&#45;&gt;</span></span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
int64</span></code></div><div class="spec-doc"><p>Enter a new implicit span. For many uses cases, <a href="#val-with_span"><code>with_span</code></a> will be easier to use.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_span"><a href="#val-exit_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_span : <span>int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit span. This should be called on the same thread as the corresponding <a href="#val-enter_span"><code>enter_span</code></a>, and nest properly with other calls to enter/exit_span and <a href="#val-with_span"><code>with_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_manual_span"><a href="#val-enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_manual_span : int64</span></code></div><div class="spec-doc"><p>Enter a new implicit span. For many uses cases, <a href="#val-with_span"><code>with_span</code></a> will be easier to use.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_span"><a href="#val-exit_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_span : <span>int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit span. This should be called on the same thread as the corresponding <a href="#val-enter_span"><code>enter_span</code></a>, and nest properly with other calls to enter/exit_span and <a href="#val-with_span"><code>with_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-enter_manual_span"><a href="#val-enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> enter_manual_span :
<span><span class="label">parent</span>:<span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">parent</span>:<span><span class="xref-unresolved">Trace_core__.Types.explicit_span_ctx</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span><span>[ `Sync <span>| `Async</span> ]</span> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">flavor</span>:<span><span>[ `Sync <span>| `Async</span> ]</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
@ -41,7 +41,7 @@
<span>| `None</span> ]</span>)</span> <span>| `None</span> ]</span>)</span>
list</span> <span class="arrow">&#45;&gt;</span></span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div><div class="spec-doc"><p>Enter an explicit span. Surrounding scope, if any, is provided by <code>parent</code>, and this function can store as much metadata as it wants in the hmap in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>'s <code>meta</code> field.</p><p>This means that the collector doesn't need to implement contextual storage mapping <a href="../../index.html#type-explicit_span.span"><code>span</code></a> to scopes, metadata, etc. on its side; everything can be transmitted in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_manual_span"><a href="#val-exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_manual_span : <span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit an explicit span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_data_to_span"><a href="#val-add_data_to_span" class="anchor"></a><code><span><span class="keyword">val</span> add_data_to_span : <span class="xref-unresolved">Trace_core__.Types.explicit_span</span></span></code></div><div class="spec-doc"><p>Enter an explicit span. Surrounding scope, if any, is provided by <code>parent</code>, and this function can store as much metadata as it wants in the hmap in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>'s <code>meta</code> field.</p><p><b>NOTE</b> the <code>parent</code> argument is now an <a href="../../index.html#type-explicit_span_ctx"><code>explicit_span_ctx</code></a> and not an <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a> since 0.10.</p><p>This means that the collector doesn't need to implement contextual storage mapping <a href="../../index.html#type-explicit_span.span"><code>span</code></a> to scopes, metadata, etc. on its side; everything can be transmitted in the <a href="../../index.html#type-explicit_span"><code>explicit_span</code></a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exit_manual_span"><a href="#val-exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> exit_manual_span : <span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit an explicit span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.3</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_data_to_span"><a href="#val-add_data_to_span" class="anchor"></a><code><span><span class="keyword">val</span> add_data_to_span :
<span>int64 <span class="arrow">&#45;&gt;</span></span> <span>int64 <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(string <span><span><span>(string
* <span>[ <span>`Int of int</span> * <span>[ <span>`Int of int</span>

19
trace/Trace_core/index.html
View file

File diff suppressed because one or more lines are too long

2
trace/Trace_event/Event/index.html Normal file
View file

File diff suppressed because one or more lines are too long

57
trace/Trace_event/Subscriber/Callbacks/index.html Normal file
View file

@ -0,0 +1,57 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Callbacks (trace.Trace_event.Subscriber.Callbacks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">trace</a> &#x00BB; <a href="../../index.html">Trace_event</a> &#x00BB; <a href="../index.html">Subscriber</a> &#x00BB; Callbacks</nav><header class="odoc-preamble"><h1>Module <code><span>Subscriber.Callbacks</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-st"><a href="#type-st" class="anchor"></a><code><span><span class="keyword">type</span> st</span><span> = <a href="../index.html#type-event_consumer">event_consumer</a></span></code></div><div class="spec-doc"><p>Type of the state passed to every callback.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the subscriber is initialized in a collector</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the collector is shutdown</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current thread is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current process is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Enter a regular (sync) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_span"><a href="#val-on_exit_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_span : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit a span. This and <code>on_enter_span</code> must follow strict stack discipline</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_add_data"><a href="#val-on_add_data" class="anchor"></a><code><span><span class="keyword">val</span> on_add_data :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Add data to a regular span (which must be active)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">span</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Emit a log message</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span>float <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Emit the current value of a counter</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_manual_span"><a href="#val-on_enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_manual_span :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">parent</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Enter a manual (possibly async) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_manual_span"><a href="#val-on_exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_manual_span :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Exit a manual span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_extension_event"><a href="#val-on_extension_event" class="anchor"></a><code><span><span class="keyword">val</span> on_extension_event :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-extension_event">Trace_core.extension_event</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Extension event</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></div></div></div></body></html>

3
trace/Trace_event/Subscriber/index.html Normal file
View file

@ -0,0 +1,3 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Subscriber (trace.Trace_event.Subscriber)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_event</a> &#x00BB; Subscriber</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_event.Subscriber</span></code></h1><p>Subscriber that emits events</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-event_consumer"><a href="#type-event_consumer" class="anchor"></a><code><span><span class="keyword">type</span> event_consumer</span><span> = </span><span>{</span></code><ol><li id="type-event_consumer.on_event" class="def record field anchored"><a href="#type-event_consumer.on_event" class="anchor"></a><code><span>on_event : <span><a href="../Event/index.html#type-t">Event.t</a> <span class="arrow">&#45;&gt;</span></span> unit;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Callback for events.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Callbacks"><a href="#module-Callbacks" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Callbacks/index.html">Callbacks</a></span><span> :
<a href="../../Trace_subscriber/Callbacks/module-type-S/index.html">Trace_event.Event.Sub.Callbacks.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Trace_subscriber/Callbacks/module-type-S/index.html#type-st">st</a> = <a href="#type-event_consumer">event_consumer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-subscriber"><a href="#val-subscriber" class="anchor"></a><code><span><span class="keyword">val</span> subscriber : <span><a href="#type-event_consumer">event_consumer</a> <span class="arrow">&#45;&gt;</span></span> <a href="../../Trace_subscriber/index.html#type-t">Trace_event.Event.Sub.t</a></span></code></div><div class="spec-doc"><p>A subscriber that turns calls into events that are passed to the <a href="#type-event_consumer"><code>event_consumer</code></a></p></div></div></div></body></html>

2
trace/Trace_event/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_event (trace.Trace_event)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_event</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_event</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Event"><a href="#module-Event" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Event/index.html">Event</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Events.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Subscriber"><a href="#module-Subscriber" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Subscriber/index.html">Subscriber</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Subscriber that emits events</p></div></div></div></body></html>

2
trace/Trace_event__Event/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_event__Event (trace.Trace_event__Event)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_event__Event</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_event__Event</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
trace/Trace_subscriber__Time_/index.html → trace/Trace_event__Subscriber/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_subscriber__Time_ (trace.Trace_subscriber__Time_)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_subscriber__Time_</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber__Time_</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_event__Subscriber (trace.Trace_event__Subscriber)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_event__Subscriber</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_event__Subscriber</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
trace/Trace_private_util/B_queue/index.html
View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B_queue (trace.Trace_private_util.B_queue)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_private_util</a> &#x00BB; B_queue</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.B_queue</span></code></h1><p>Basic Blocking Queue</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">_</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Closed"><a href="#exception-Closed" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Closed</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-push"><a href="#val-push" class="anchor"></a><code><span><span class="keyword">val</span> push : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>push q x</code> pushes <code>x</code> into <code>q</code>, and returns <code>()</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="#exception-Closed"><code>Closed</code></a> <p>if <code>close q</code> was previously called.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pop_all"><a href="#val-pop_all" class="anchor"></a><code><span><span class="keyword">val</span> pop_all : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> list</span></span></code></div><div class="spec-doc"><p><code>pop_all bq</code> returns all items presently in <code>bq</code>, in the same order, and clears <code>bq</code>. It blocks if no element is in <code>bq</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><span><span class="type-var">_</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Close the queue, meaning there won't be any more <code>push</code> allowed.</p></div></div></div></body></html>

2
trace/Trace_private_util/Mpsc_bag/index.html
View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mpsc_bag (trace.Trace_private_util.Mpsc_bag)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_private_util</a> &#x00BB; Mpsc_bag</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.Mpsc_bag</span></code></h1><p>A multi-producer, single-consumer bag</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>add q x</code> adds <code>x</code> in the bag.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pop_all"><a href="#val-pop_all" class="anchor"></a><code><span><span class="keyword">val</span> pop_all : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> list</span> option</span></span></code></div><div class="spec-doc"><p>Return all current items in the insertion order.</p></div></div></div></body></html>

7
trace/Trace_private_util/Rpool/index.html Normal file
View file

@ -0,0 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Rpool (trace.Trace_private_util.Rpool)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_private_util</a> &#x00BB; Rpool</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util.Rpool</span></code></h1><p>A resource pool (for buffers)</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create :
<span><span class="label">max_size</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">create</span>:<span>(<span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">clear</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-alloc"><a href="#val-alloc" class="anchor"></a><code><span><span class="keyword">val</span> alloc : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recycle"><a href="#val-recycle" class="anchor"></a><code><span><span class="keyword">val</span> recycle : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span></span></code></div></div></div></body></html>

2
trace/Trace_private_util/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_private_util (trace.Trace_private_util)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_private_util</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-B_queue"><a href="#module-B_queue" class="anchor"></a><code><span><span class="keyword">module</span> <a href="B_queue/index.html">B_queue</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Basic Blocking Queue</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Domain_util"><a href="#module-Domain_util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Domain_util/index.html">Domain_util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Mpsc_bag"><a href="#module-Mpsc_bag" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Mpsc_bag/index.html">Mpsc_bag</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A multi-producer, single-consumer bag</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_private_util (trace.Trace_private_util)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_private_util</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Domain_util"><a href="#module-Domain_util" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Domain_util/index.html">Domain_util</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Rpool"><a href="#module-Rpool" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Rpool/index.html">Rpool</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A resource pool (for buffers)</p></div></div></div></body></html>

2
trace/Trace_private_util__B_queue/index.html
View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_private_util__B_queue (trace.Trace_private_util__B_queue)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_private_util__B_queue</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util__B_queue</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
trace/Trace_private_util__Mpsc_bag/index.html
View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_private_util__Mpsc_bag (trace.Trace_private_util__Mpsc_bag)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_private_util__Mpsc_bag</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util__Mpsc_bag</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
trace/Trace_subscriber__Thread_/index.html → trace/Trace_private_util__Rpool/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_subscriber__Thread_ (trace.Trace_subscriber__Thread_)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_subscriber__Thread_</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber__Thread_</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_private_util__Rpool (trace.Trace_private_util__Rpool)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_private_util__Rpool</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_private_util__Rpool</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

6
trace/Trace_subscriber/Callbacks/Dummy/index.html
View file

@ -1,5 +1,9 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dummy (trace.Trace_subscriber.Callbacks.Dummy)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">trace</a> &#x00BB; <a href="../../index.html">Trace_subscriber</a> &#x00BB; <a href="../index.html">Callbacks</a> &#x00BB; Dummy</nav><header class="odoc-preamble"><h1>Module <code><span>Callbacks.Dummy</span></code></h1><p>Dummy callbacks. It can be useful to reuse some of these functions in a real subscriber that doesn't want to handle <b>all</b> events, but only some of them.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">span</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Dummy (trace.Trace_subscriber.Callbacks.Dummy)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">trace</a> &#x00BB; <a href="../../index.html">Trace_subscriber</a> &#x00BB; <a href="../index.html">Callbacks</a> &#x00BB; Dummy</nav><header class="odoc-preamble"><h1>Module <code><span>Callbacks.Dummy</span></code></h1><p>Dummy callbacks. It can be useful to reuse some of these functions in a real subscriber that doesn't want to handle <b>all</b> events, but only some of them.</p><p>To write a subscriber that only supports some callbacks, this can be handy:</p><pre class="language-ocaml"><code> module My_callbacks = struct
type st = my_own_state
include Callbacks.Dummy
let on_counter (st:st) ~time_ns ~tid ~data ~name v : unit = ...
end</code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">span</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span class="type-var">'d</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:<span class="type-var">'e</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'f</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span :
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FUNCTION__</span>:<span class="type-var">'b</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FILE__</span>:<span class="type-var">'c</span> <span class="arrow">&#45;&gt;</span></span>

4
trace/Trace_subscriber/Callbacks/index.html
View file

@ -1,5 +1,5 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Callbacks (trace.Trace_subscriber.Callbacks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_subscriber</a> &#x00BB; Callbacks</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber.Callbacks</span></code></h1><p>Callbacks used for subscribers.</p><p>Each subscriber defines a set of callbacks, for each possible tracing event. These callbacks take a custom state that is paired with the callbacks in <a href="../Subscriber/index.html#type-t"><code>Subscriber.t</code></a>.</p><p>To use a default implementation for some callbacks, use:</p><pre class="language-ocaml"><code>module My_callbacks = struct <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Callbacks (trace.Trace_subscriber.Callbacks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_subscriber</a> &#x00BB; Callbacks</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber.Callbacks</span></code></h1><p>Callbacks used for subscribers.</p><p>Each subscriber defines a set of callbacks, for each possible tracing event. These callbacks take a custom state that is paired with the callbacks in <a href="../Subscriber/index.html#type-t"><code>Subscriber.t</code></a>.</p><p>To use a default implementation for some callbacks, use:</p><pre class="language-ocaml"><code> module My_callbacks = struct
type st = … type st = …
include Trace_subscriber.Callbacks.Dummy include Trace_subscriber.Callbacks.Dummy
@ -7,4 +7,4 @@
let on_init (state:st) ~time_ns : unit = … let on_init (state:st) ~time_ns : unit = …
(* … other custom callbacks … *) (* … other custom callbacks … *)
end </code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>First class module signature for callbacks</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'st t</span></span><span> = <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-st">st</a> = <span class="type-var">'st</span>)</span></span></code></div><div class="spec-doc"><p>Callbacks for a subscriber. There is one callback per event in <a href="../../Trace/index.html"><code>Trace</code></a>. The type <code>'st</code> is the state that is passed to every single callback.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Dummy"><a href="#module-Dummy" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Dummy/index.html">Dummy</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dummy callbacks. It can be useful to reuse some of these functions in a real subscriber that doesn't want to handle <b>all</b> events, but only some of them.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy"><a href="#val-dummy" class="anchor"></a><code><span><span class="keyword">val</span> dummy : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'st</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Dummy callbacks, ignores all events.</p></div></div></div></body></html> end</code></pre><p><b>NOTE</b>: the <code>trace_id</code> passed alongside manual spans is guaranteed to be at least 64 bits.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>First class module signature for callbacks</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'st t</span></span><span> = <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-st">st</a> = <span class="type-var">'st</span>)</span></span></code></div><div class="spec-doc"><p>Callbacks for a subscriber. There is one callback per event in <a href="../../Trace/index.html"><code>Trace</code></a>. The type <code>'st</code> is the state that is passed to every single callback.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Dummy"><a href="#module-Dummy" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Dummy/index.html">Dummy</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Dummy callbacks. It can be useful to reuse some of these functions in a real subscriber that doesn't want to handle <b>all</b> events, but only some of them.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy"><a href="#val-dummy" class="anchor"></a><code><span><span class="keyword">val</span> dummy : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'st</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Dummy callbacks, ignores all events.</p></div></div></div></body></html>

20
trace/Trace_subscriber/Callbacks/module-type-S/index.html
View file

@ -1,28 +1,28 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (trace.Trace_subscriber.Callbacks.S)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">trace</a> &#x00BB; <a href="../../index.html">Trace_subscriber</a> &#x00BB; <a href="../index.html">Callbacks</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Callbacks.S</span></code></h1><p>First class module signature for callbacks</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-st"><a href="#type-st" class="anchor"></a><code><span><span class="keyword">type</span> st</span></code></div><div class="spec-doc"><p>Type of the state passed to every callback.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the subscriber is initialized in a collector</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the collector is shutdown</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current thread is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current process is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (trace.Trace_subscriber.Callbacks.S)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> &#x00BB; <a href="../../../index.html">trace</a> &#x00BB; <a href="../../index.html">Trace_subscriber</a> &#x00BB; <a href="../index.html">Callbacks</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Callbacks.S</span></code></h1><p>First class module signature for callbacks</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-st"><a href="#type-st" class="anchor"></a><code><span><span class="keyword">type</span> st</span></code></div><div class="spec-doc"><p>Type of the state passed to every callback.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the subscriber is initialized in a collector</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Called when the collector is shutdown</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current thread is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Current process is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Enter a regular (sync) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_span"><a href="#val-on_exit_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_span : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit a span. This and <code>on_enter_span</code> must follow strict stack discipline</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_add_data"><a href="#val-on_add_data" class="anchor"></a><code><span><span class="keyword">val</span> on_add_data : unit</span></code></div><div class="spec-doc"><p>Enter a regular (sync) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_span"><a href="#val-on_exit_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_span : <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Exit a span. This and <code>on_enter_span</code> must follow strict stack discipline</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_add_data"><a href="#val-on_add_data" class="anchor"></a><code><span><span class="keyword">val</span> on_add_data :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Add data to a regular span (which must be active)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message : unit</span></code></div><div class="spec-doc"><p>Add data to a regular span (which must be active)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">span</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">span</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Emit a log message</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter : unit</span></code></div><div class="spec-doc"><p>Emit a log message</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
@ -32,26 +32,26 @@
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__FILE__</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">__LINE__</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">parent</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">parent</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Enter a manual (possibly async) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_manual_span"><a href="#val-on_exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_manual_span : unit</span></code></div><div class="spec-doc"><p>Enter a manual (possibly async) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_manual_span"><a href="#val-on_exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_manual_span :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">trace_id</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Exit a manual span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_extension_event"><a href="#val-on_extension_event" class="anchor"></a><code><span><span class="keyword">val</span> on_extension_event : unit</span></code></div><div class="spec-doc"><p>Exit a manual span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_extension_event"><a href="#val-on_extension_event" class="anchor"></a><code><span><span class="keyword">val</span> on_extension_event :
<span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-st">st</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">time_ns</span>:float <span class="arrow">&#45;&gt;</span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="label">tid</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../Trace_core/index.html#type-extension_event">Trace_core.extension_event</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../Trace_core/index.html#type-extension_event">Trace_core.extension_event</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Extension event</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></div></div></div></body></html> unit</span></code></div><div class="spec-doc"><p>Extension event</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></div></div></div></body></html>

2
trace/Trace_subscriber/Span_tbl/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span_tbl (trace.Trace_subscriber.Span_tbl)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_subscriber</a> &#x00BB; Span_tbl</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber.Span_tbl</span></code></h1><p>A table that can be used to remember information about spans.</p><p>This is convenient when we want to rememner information from a span begin, when dealing with the corresponding span end.</p><p><b>NOTE</b>: this is thread safe when threads are enabled.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'v t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span><span><span class="type-var">'v</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'v</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_exn"><a href="#val-find_exn" class="anchor"></a><code><span><span class="keyword">val</span> find_exn : <span><span><span class="type-var">'v</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'v</span></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Not_found</code> <p>if information isn't found</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><span><span class="type-var">_</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Remove the span if present</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span><span class="keyword">val</span> to_list : <span><span><span class="type-var">'v</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="../../Trace_core/index.html#type-span">Trace_core.span</a> * <span class="type-var">'v</span>)</span> list</span></span></code></div></div></div></body></html>

2
trace/Trace_subscriber/Subscriber/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Subscriber (trace.Trace_subscriber.Subscriber)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_subscriber</a> &#x00BB; Subscriber</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber.Subscriber</span></code></h1><p>Trace subscribers</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span></code><ol><li id="type-t.Sub" class="def variant constructor anchored"><a href="#type-t.Sub" class="anchor"></a><code><span>| </span><span><span class="constructor">Sub</span> : </span><span>{</span></code><ol><li id="type-t.st" class="def record field anchored"><a href="#type-t.st" class="anchor"></a><code><span>st : <span class="type-var">'st</span>;</span></code></li><li id="type-t.callbacks" class="def record field anchored"><a href="#type-t.callbacks" class="anchor"></a><code><span>callbacks : <span><span class="type-var">'st</span> <a href="../Callbacks/index.html#type-t">Callbacks.t</a></span>;</span></code></li></ol><code><span>}</span><span> <span class="arrow">&#45;&gt;</span> <a href="#type-t">t</a></span></code></li></ol></div><div class="spec-doc"><p>A trace subscriber. It pairs a set of callbacks with the state they need (which can contain a file handle, a socket to write events to, config, etc.).</p><p>The design goal for this is that it should be possible to avoid allocations whenever the trace collector invokes the callbacks.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy"><a href="#val-dummy" class="anchor"></a><code><span><span class="keyword">val</span> dummy : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Dummy subscriber that ignores every call.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee"><a href="#val-tee" class="anchor"></a><code><span><span class="keyword">val</span> tee : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>tee s1 s2</code> is a subscriber that forwards every call to <code>s1</code> and <code>s2</code> both.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee_l"><a href="#val-tee_l" class="anchor"></a><code><span><span class="keyword">val</span> tee_l : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Tee multiple subscribers, ie return a subscriber that forwards to all the subscribers in <code>subs</code>.</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Subscriber (trace.Trace_subscriber.Subscriber)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> &#x00BB; <a href="../../index.html">trace</a> &#x00BB; <a href="../index.html">Trace_subscriber</a> &#x00BB; Subscriber</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber.Subscriber</span></code></h1><p>Trace subscribers</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span></code><ol><li id="type-t.Sub" class="def variant constructor anchored"><a href="#type-t.Sub" class="anchor"></a><code><span>| </span><span><span class="constructor">Sub</span> : </span><span>{</span></code><ol><li id="type-t.st" class="def record field anchored"><a href="#type-t.st" class="anchor"></a><code><span>st : <span class="type-var">'st</span>;</span></code></li><li id="type-t.callbacks" class="def record field anchored"><a href="#type-t.callbacks" class="anchor"></a><code><span>callbacks : <span><span class="type-var">'st</span> <a href="../Callbacks/index.html#type-t">Callbacks.t</a></span>;</span></code></li></ol><code><span>}</span><span> <span class="arrow">&#45;&gt;</span> <a href="#type-t">t</a></span></code></li></ol></div><div class="spec-doc"><p>A trace subscriber. It pairs a set of callbacks with the state they need (which can contain a file handle, a socket to write events to, config, etc.).</p><p>The design goal for this is that it should be possible to avoid allocations whenever the trace collector invokes the callbacks.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy"><a href="#val-dummy" class="anchor"></a><code><span><span class="keyword">val</span> dummy : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Dummy subscriber that ignores every call.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee_l"><a href="#val-tee_l" class="anchor"></a><code><span><span class="keyword">val</span> tee_l : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Tee multiple subscribers, ie return a subscriber that forwards to all the subscribers in <code>subs</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tee"><a href="#val-tee" class="anchor"></a><code><span><span class="keyword">val</span> tee : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>tee s1 s2</code> is a subscriber that forwards every call to <code>s1</code> and <code>s2</code> both.</p></div></div></div></body></html>

2
trace/Trace_subscriber/index.html
View file

File diff suppressed because one or more lines are too long

2
trace/Trace_subscriber__Span_tbl/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_subscriber__Span_tbl (trace.Trace_subscriber__Span_tbl)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">trace</a> &#x00BB; Trace_subscriber__Span_tbl</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_subscriber__Span_tbl</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

19
trace/_doc-dir/CHANGES.md
View file

@ -1,3 +1,22 @@
# 0.10
- breaking: manual spans now take a `explicit_span_ctx` as parent, that
can potentially be transmitted across processes/machines. It also
is intended to be more compatible with OTEL.
- breaking `trace.subscriber`: timestamps are `int64`ns now, not floats
- breaking `trace`: pass a `string` trace_id in manual spans, which helps
for backends such as opentelemetry. It's also useful for extensions.
- refactor `trace-fuchsia`: full revamp of the library, modularized, using subscriber API
- refactor `trace-tef`: split into exporter,writer,subscriber, using subscriber API
- feat: add `trace.event`, useful for background threads
- feat `trace.subscriber`: add `Span_tbl`, and a depopt on picos_aux
- feat `trace.subscriber`: tee a whole array at once
- feat tef-tldrs: use EMIT_TEF_AT_EXIT
- feat `trace.subscriber`: depopt on unix for timestamps
- refactor `trace-tef`: depopt on unix for TEF timestamps
# 0.9.1 # 0.9.1

2
trace/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (trace.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">Index</a> &#x00BB; trace</nav><header class="odoc-preamble"><h1 id="package-trace"><a href="#package-trace" class="anchor"></a>Package trace <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Trace/index.html"><code>Trace</code></a> </li><li><a href="Trace_core/index.html"><code>Trace_core</code></a> <span class="synopsis">Trace.</span></li><li><a href="Trace_private_util/index.html"><code>Trace_private_util</code></a> </li><li><a href="Trace_subscriber/index.html"><code>Trace_subscriber</code></a> <span class="synopsis">Generic subscribers.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (trace.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">Index</a> &#x00BB; trace</nav><header class="odoc-preamble"><h1 id="package-trace"><a href="#package-trace" class="anchor"></a>Package trace <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Trace/index.html"><code>Trace</code></a> </li><li><a href="Trace_core/index.html"><code>Trace_core</code></a> <span class="synopsis">Trace.</span></li><li><a href="Trace_event/index.html"><code>Trace_event</code></a> </li><li><a href="Trace_private_util/index.html"><code>Trace_private_util</code></a> </li><li><a href="Trace_subscriber/index.html"><code>Trace_subscriber</code></a> <span class="synopsis">Generic subscribers.</span></li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>