mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-09 12:23:32 -04:00
2 lines
5.5 KiB
HTML
2 lines
5.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Simple_span (trace.Trace_simple.Simple_span)</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_simple</a> » Simple_span</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_simple.Simple_span</span></code></h1><p>A simple span.</p><p>This is a concrete representation of spans that is convenient to manipulate.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.11</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-span_flavor"><a href="#type-span_flavor" class="anchor"></a><code><span><span class="keyword">type</span> span_flavor</span><span> = </span><span>[ </span></code><ol><li id="type-span_flavor.Sync" class="def variant constructor anchored"><a href="#type-span_flavor.Sync" class="anchor"></a><code><span>| </span><span>`Sync</span></code></li><li id="type-span_flavor.Async" class="def variant constructor anchored"><a href="#type-span_flavor.Async" class="anchor"></a><code><span>| </span><span>`Async</span></code></li></ol><code><span> ]</span></code></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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.name" class="def record field anchored"><a href="#type-t.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-t.__FUNCTION__" class="def record field anchored"><a href="#type-t.__FUNCTION__" class="anchor"></a><code><span>__FUNCTION__ : <span>string option</span>;</span></code></li><li id="type-t.__FILE__" class="def record field anchored"><a href="#type-t.__FILE__" class="anchor"></a><code><span>__FILE__ : string;</span></code></li><li id="type-t.__LINE__" class="def record field anchored"><a href="#type-t.__LINE__" class="anchor"></a><code><span>__LINE__ : int;</span></code></li><li id="type-t.time_ns" class="def record field anchored"><a href="#type-t.time_ns" class="anchor"></a><code><span>time_ns : int64;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Time the span was entered.</p><span class="comment-delim">*)</span></div></li><li id="type-t.time_exit_ns" class="def record field anchored"><a href="#type-t.time_exit_ns" class="anchor"></a><code><span><span class="keyword">mutable</span> time_exit_ns : int64;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Time the span was exited. Set at exit, <code>Int64.max_int</code> otherwise</p><span class="comment-delim">*)</span></div></li><li id="type-t.tid" class="def record field anchored"><a href="#type-t.tid" class="anchor"></a><code><span>tid : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Thread in which span was created</p><span class="comment-delim">*)</span></div></li><li id="type-t.trace_id" class="def record field anchored"><a href="#type-t.trace_id" class="anchor"></a><code><span>trace_id : int64;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>For async spans</p><span class="comment-delim">*)</span></div></li><li id="type-t.parent" class="def record field anchored"><a href="#type-t.parent" class="anchor"></a><code><span>parent : <a href="../../Trace_core/index.html#type-parent">Trace_core.parent</a>;</span></code></li><li id="type-t.flavor" class="def record field anchored"><a href="#type-t.flavor" class="anchor"></a><code><span>flavor : <a href="#type-span_flavor">span_flavor</a>;</span></code></li><li id="type-t.params" class="def record field anchored"><a href="#type-t.params" class="anchor"></a><code><span>params : <span><a href="../../Trace_core/index.html#type-extension_parameter">Trace_core.extension_parameter</a> list</span>;</span></code></li><li id="type-t.data" class="def record field anchored"><a href="#type-t.data" class="anchor"></a><code><span><span class="keyword">mutable</span> data : <span><span>(string * <a href="../../Trace_core/index.html#type-user_data">Trace_core.user_data</a>)</span> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Modified by <code>add_data_to_span</code></p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The type of spans used by all subscribers.</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Span_simple"><a href="#extension-decl-Span_simple" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../Trace_core/index.html#type-span">Trace_core.span</a> += </span></code><ol><li id="extension-Span_simple" class="def variant extension anchored"><a href="#extension-Span_simple" class="anchor"></a><code><span>| </span><span><span class="extension">Span_simple</span> <span class="keyword">of</span> <a href="#type-t">t</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>How to turn a <a href="#type-t"><code>Simple_span.t</code></a> into a <code>span</code>.</p><span class="comment-delim">*)</span></div></li></ol></div></div></div></body></html>
|