mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-08 03:47:57 -04:00
deploy: a4144ff3d1
This commit is contained in:
c-cube
parent
a398dc03da
commit
2c874b6191
4 changed files with 34 additions and 41 deletions
File diff suppressed because one or more lines are too long
|
|
@ -3,6 +3,7 @@
|
|||
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">__FILE__</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="label">__LINE__</span>:int <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -24,6 +25,7 @@
|
|||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
unit;</span></code></li><li id="type-t.message" class="def record field anchored"><a href="#type-t.message" class="anchor"></a><code><span>message : <span><span class="type-var">'st</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -35,7 +37,8 @@
|
|||
list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">span</span>:<span><span class="xref-unresolved">Trace_core__.Types.span</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Emit a message or log</p><span class="comment-delim">*)</span></div></li><li id="type-t.counter_int" class="def record field anchored"><a href="#type-t.counter_int" class="anchor"></a><code><span>counter_int : <span><span class="type-var">'st</span> <span class="arrow">-></span></span>
|
||||
unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Emit a message or log</p><span class="comment-delim">*)</span></div></li><li id="type-t.metric" class="def record field anchored"><a href="#type-t.metric" class="anchor"></a><code><span>metric : <span><span class="type-var">'st</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -46,25 +49,14 @@
|
|||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>int <span class="arrow">-></span></span>
|
||||
unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Integer counter.</p><span class="comment-delim">*)</span></div></li><li id="type-t.counter_float" class="def record field anchored"><a href="#type-t.counter_float" class="anchor"></a><code><span>counter_float : <span><span class="type-var">'st</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</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">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>float <span class="arrow">-></span></span>
|
||||
unit;</span></code></li><li id="type-t.extension" class="def record field anchored"><a href="#type-t.extension" class="anchor"></a><code><span>extension : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Trace_core__.Types.extension_event</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Collector-specific extension</p><span class="comment-delim">*)</span></div></li><li id="type-t.init" class="def record field anchored"><a href="#type-t.init" class="anchor"></a><code><span>init : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Called on initialization</p><span class="comment-delim">*)</span></div></li><li id="type-t.shutdown" class="def record field anchored"><a href="#type-t.shutdown" class="anchor"></a><code><span>shutdown : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Shutdown collector, possibly waiting for it to finish sending data.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Callbacks taking a state <code>'st</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||||
<span><span class="xref-unresolved">Trace_core__.Types.metric</span> <span class="arrow">-></span></span>
|
||||
unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Metric .</p><span class="comment-delim">*)</span></div></li><li id="type-t.extension" class="def record field anchored"><a href="#type-t.extension" class="anchor"></a><code><span>extension : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> <span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Trace_core__.Types.extension_event</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Collector-specific extension. It now has a level as well.</p><span class="comment-delim">*)</span></div></li><li id="type-t.init" class="def record field anchored"><a href="#type-t.init" class="anchor"></a><code><span>init : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Called on initialization</p><span class="comment-delim">*)</span></div></li><li id="type-t.shutdown" class="def record field anchored"><a href="#type-t.shutdown" class="anchor"></a><code><span>shutdown : <span><span class="type-var">'st</span> <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Shutdown collector, possibly waiting for it to finish sending data.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Callbacks taking a state <code>'st</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||||
<span><span class="label">enter_span</span>:
|
||||
<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">__FILE__</span>:string <span class="arrow">-></span></span>
|
||||
<span><span class="label">__LINE__</span>:int <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -91,6 +83,7 @@
|
|||
unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">message</span>:
|
||||
<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -103,8 +96,9 @@
|
|||
<span><span class="label">span</span>:<span><span class="xref-unresolved">Trace_core__.Types.span</span> option</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">counter_int</span>:
|
||||
<span><span class="label">metric</span>:
|
||||
<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</span>:
|
||||
<span><span>(string
|
||||
|
|
@ -115,23 +109,10 @@
|
|||
<span>| `None</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>int <span class="arrow">-></span></span>
|
||||
<span><span class="xref-unresolved">Trace_core__.Types.metric</span> <span class="arrow">-></span></span>
|
||||
unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">counter_float</span>:
|
||||
<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">params</span>:<span><span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> list</span> <span class="arrow">-></span></span>
|
||||
<span><span class="label">data</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">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span>float <span class="arrow">-></span></span>
|
||||
unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?extension</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Trace_core__.Types.extension_event</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?extension</span>:
|
||||
<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="label">level</span>:<a href="../../Level/index.html#type-t">Level.t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Trace_core__.Types.extension_event</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?init</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?shutdown</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Core_ext (trace.Trace_core.Core_ext)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">trace</a> » <a href="../index.html">Trace_core</a> » Core_ext</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_core.Core_ext</span></code></h1><p>A few core extensions.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Extension_set_thread_name"><a href="#extension-decl-Extension_set_thread_name" class="anchor"></a><code><span><span class="keyword">type</span> <span class="xref-unresolved">Trace_core__.Types.extension_event</span> += </span></code><ol><li id="extension-Extension_set_thread_name" class="def variant extension anchored"><a href="#extension-Extension_set_thread_name" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_set_thread_name</span> <span class="keyword">of</span> string</span></code></li><li id="extension-Extension_set_process_name" class="def variant extension anchored"><a href="#extension-Extension_set_process_name" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_set_process_name</span> <span class="keyword">of</span> string</span></code></li></ol></div><div class="spec-doc"><p>Additional extensions</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Extension_span_flavor"><a href="#extension-decl-Extension_span_flavor" class="anchor"></a><code><span><span class="keyword">type</span> <span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> += </span></code><ol><li id="extension-Extension_span_flavor" class="def variant extension anchored"><a href="#extension-Extension_span_flavor" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_span_flavor</span> <span class="keyword">of</span> <span>[ `Async <span>| `Sync</span> ]</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Tell the backend if this is a sync or async span</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Specialized parameters</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Core_ext (trace.Trace_core.Core_ext)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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> » <a href="../../index.html">trace</a> » <a href="../index.html">Trace_core</a> » Core_ext</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_core.Core_ext</span></code></h1><p>A few core extensions.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Extension_set_thread_name"><a href="#extension-decl-Extension_set_thread_name" class="anchor"></a><code><span><span class="keyword">type</span> <span class="xref-unresolved">Trace_core__.Types.extension_event</span> += </span></code><ol><li id="extension-Extension_set_thread_name" class="def variant extension anchored"><a href="#extension-Extension_set_thread_name" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_set_thread_name</span> <span class="keyword">of</span> string</span></code></li><li id="extension-Extension_set_process_name" class="def variant extension anchored"><a href="#extension-Extension_set_process_name" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_set_process_name</span> <span class="keyword">of</span> string</span></code></li></ol></div><div class="spec-doc"><p>Additional extensions</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Extension_span_flavor"><a href="#extension-decl-Extension_span_flavor" class="anchor"></a><code><span><span class="keyword">type</span> <span class="xref-unresolved">Trace_core__.Types.extension_parameter</span> += </span></code><ol><li id="extension-Extension_span_flavor" class="def variant extension anchored"><a href="#extension-Extension_span_flavor" class="anchor"></a><code><span>| </span><span><span class="extension">Extension_span_flavor</span> <span class="keyword">of</span> <span>[ `Async <span>| `Sync</span> ]</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Tell the backend if this is a sync or async span</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Specialized parameters</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Metric_int"><a href="#extension-decl-Metric_int" class="anchor"></a><code><span><span class="keyword">type</span> <span class="xref-unresolved">Trace_core__.Types.metric</span> += </span></code><ol><li id="extension-Metric_int" class="def variant extension anchored"><a href="#extension-Metric_int" class="anchor"></a><code><span>| </span><span><span class="extension">Metric_int</span> <span class="keyword">of</span> int</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Int counter or gauge, supported by tracy, TEF, etc</p><span class="comment-delim">*)</span></div></li><li id="extension-Metric_float" class="def variant extension anchored"><a href="#extension-Metric_float" class="anchor"></a><code><span>| </span><span><span class="extension">Metric_float</span> <span class="keyword">of</span> float</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Float counter or gauge, supported by tracy, TEF, etc</p><span class="comment-delim">*)</span></div></li></ol></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue