simon/ocaml-trace
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-trace.git synced 2026-03-09 12:23:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 771193e15c15382460a313435f5356c1a6bd32e8

Browse source
This commit is contained in:
c-cube 2024-02-24 16:31:29 +00:00
parent a3535dfe6c
commit cfbf45dffd
8 changed files with 111 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
trace/Trace/index.html
View file

File diff suppressed because one or more lines are too long

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

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (trace.Trace_core.Collector)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">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>

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

@ -0,0 +1,95 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (trace.Trace_core.Collector.S)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">trace</a> &#x00BB; <a href="../../index.html">Trace_core</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.S</span></code></h1><p>Signature for a collector.</p><p>This is only relevant to implementors of tracing backends; to instrument your code you only need to look at the <a href="../../../Trace/index.html"><code>Trace</code></a> module.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-with_span"><a href="#val-with_span" class="anchor"></a><code><span><span class="keyword">val</span> with_span :
<span>__FUNCTION__:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span>__FILE__:string <span class="arrow">&#45;&gt;</span></span>
<span>__LINE__:int <span class="arrow">&#45;&gt;</span></span>
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <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 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>__FUNCTION__:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span>__FILE__:string <span class="arrow">&#45;&gt;</span></span>
<span>__LINE__:int <span class="arrow">&#45;&gt;</span></span>
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <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 :
<span>parent:<span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>flavor:<span><span>[ `Sync <span>| `Async</span> ]</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>__FUNCTION__:<span>string option</span> <span class="arrow">&#45;&gt;</span></span>
<span>__FILE__:string <span class="arrow">&#45;&gt;</span></span>
<span>__LINE__:int <span class="arrow">&#45;&gt;</span></span>
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <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>int64 <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> Adds data to the current span.</li></ul><p>0.4</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_data_to_manual_span"><a href="#val-add_data_to_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> add_data_to_manual_span :
<span><span class="xref-unresolved">Trace_core__.Types.explicit_span</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Adds data to the given span.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-message"><a href="#val-message" class="anchor"></a><code><span><span class="keyword">val</span> message :
<span>?span:int64 <span class="arrow">&#45;&gt;</span></span>
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</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 message with associated metadata.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name_thread"><a href="#val-name_thread" class="anchor"></a><code><span><span class="keyword">val</span> name_thread : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give a name to the current thread.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name_process"><a href="#val-name_process" class="anchor"></a><code><span><span class="keyword">val</span> name_process : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give a name to the current process.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-counter_int"><a href="#val-counter_int" class="anchor"></a><code><span><span class="keyword">val</span> counter_int :
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Integer counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-counter_float"><a href="#val-counter_float" class="anchor"></a><code><span><span class="keyword">val</span> counter_float :
<span>data:
<span><span>(string
* <span>[ <span>`Int of int</span>
<span><span>| `String</span> of string</span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span>| `None</span> ]</span>)</span>
list</span> <span class="arrow">&#45;&gt;</span></span>
<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>Float counter.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Shutdown collector, possibly waiting for it to finish sending data.</p></div></div></div></body></html>

2
trace/Trace_core/Meta_map/Key/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (trace.Trace_core.Meta_map.Key)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">trace</a> &#x00BB; <a href="../../index.html">Trace_core</a> &#x00BB; <a href="../index.html">Meta_map</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Meta_map.Key</span></code></h1></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><span> = <span>(<span class="keyword">module</span> <a href="../module-type-KEY_IMPL/index.html">KEY_IMPL</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../module-type-KEY_IMPL/index.html#type-t">t</a> = <span class="type-var">'a</span>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-_n"><a href="#val-_n" class="anchor"></a><code><span><span class="keyword">val</span> _n : <span>int <span class="xref-unresolved">Stdlib</span>.ref</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="keyword">module</span> <a href="../module-type-KEY_IMPL/index.html">KEY_IMPL</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../module-type-KEY_IMPL/index.html#type-t">t</a> = <span class="type-var">'k</span>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-id"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : <span><span>(<span class="keyword">module</span> <a href="../module-type-KEY_IMPL/index.html">KEY_IMPL</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../module-type-KEY_IMPL/index.html#type-t">t</a> = <span class="type-var">'k</span>)</span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : 'a 'b. <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">'b</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></div></body></html>

6
trace/Trace_core/Meta_map/M/index.html Normal file
View file

File diff suppressed because one or more lines are too long

2
trace/Trace_core/Meta_map/index.html Normal file
View file

File diff suppressed because one or more lines are too long

2
trace/Trace_core/Meta_map/module-type-KEY_IMPL/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>KEY_IMPL (trace.Trace_core.Meta_map.KEY_IMPL)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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">trace</a> &#x00BB; <a href="../../index.html">Trace_core</a> &#x00BB; <a href="../index.html">Meta_map</a> &#x00BB; KEY_IMPL</nav><header class="odoc-preamble"><h1>Module type <code><span>Meta_map.KEY_IMPL</span></code></h1></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></code></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Store"><a href="#exception-Store" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Store</span> <span class="keyword">of</span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-id"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : int</span></code></div></div></div></body></html>

2
trace/Trace_core/index.html
View file

File diff suppressed because one or more lines are too long