mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-08 20:07:55 -04:00
21 lines
8.3 KiB
HTML
21 lines
8.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span (opentelemetry.Opentelemetry.Span)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Span</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span</span></code></h1><p>Spans.</p><p>A Span is the workhorse of traces, it indicates an operation that took place over a given span of time (indicated by start_time and end_time) as part of a hierarchical trace. All spans in a given trace are bound by the use of the same <a href="../Trace_id/index.html#type-t"><code>Trace_id.t</code></a>.</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> = <a href="../../Opentelemetry_proto/Trace/index.html#type-span">Proto.Trace.span</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-id"><a href="#type-id" class="anchor"></a><code><span><span class="keyword">type</span> id</span><span> = <a href="../Span_id/index.html#type-t">Span_id.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-kind"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> kind</span><span> = <a href="../../Opentelemetry_proto/Trace/index.html#type-span_span_kind">Proto.Trace.span_span_kind</a></span><span> = </span></code><ol><li id="type-kind.Span_kind_unspecified" class="def variant constructor anchored"><a href="#type-kind.Span_kind_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_unspecified</span></span></code></li><li id="type-kind.Span_kind_internal" class="def variant constructor anchored"><a href="#type-kind.Span_kind_internal" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_internal</span></span></code></li><li id="type-kind.Span_kind_server" class="def variant constructor anchored"><a href="#type-kind.Span_kind_server" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_server</span></span></code></li><li id="type-kind.Span_kind_client" class="def variant constructor anchored"><a href="#type-kind.Span_kind_client" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_client</span></span></code></li><li id="type-kind.Span_kind_producer" class="def variant constructor anchored"><a href="#type-kind.Span_kind_producer" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_producer</span></span></code></li><li id="type-kind.Span_kind_consumer" class="def variant constructor anchored"><a href="#type-kind.Span_kind_consumer" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_consumer</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-status_code"><a href="#type-status_code" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> status_code</span><span> = <a href="../../Opentelemetry_proto/Trace/index.html#type-status_status_code">Proto.Trace.status_status_code</a></span><span> = </span></code><ol><li id="type-status_code.Status_code_unset" class="def variant constructor anchored"><a href="#type-status_code.Status_code_unset" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_unset</span></span></code></li><li id="type-status_code.Status_code_ok" class="def variant constructor anchored"><a href="#type-status_code.Status_code_ok" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_ok</span></span></code></li><li id="type-status_code.Status_code_error" class="def variant constructor anchored"><a href="#type-status_code.Status_code_error" class="anchor"></a><code><span>| </span><span><span class="constructor">Status_code_error</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-status"><a href="#type-status" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> status</span><span> = <a href="../../Opentelemetry_proto/Trace/index.html#type-status">Proto.Trace.status</a></span><span> = </span><span>{</span></code><ol><li id="type-status.message" class="def record field anchored"><a href="#type-status.message" class="anchor"></a><code><span>message : string;</span></code></li><li id="type-status.code" class="def record field anchored"><a href="#type-status.code" class="anchor"></a><code><span>code : <a href="#type-status_code">status_code</a>;</span></code></li></ol><code><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><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../Span_id/index.html#type-t">Span_id.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-key_value"><a href="#type-key_value" class="anchor"></a><code><span><span class="keyword">type</span> key_value</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></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="optlabel">?kind</span>:<a href="#type-kind">kind</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?id</span>:<a href="#type-id">id</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?trace_state</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?attrs</span>:<span><a href="#type-key_value">key_value</a> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?events</span>:<span><a href="../Event/index.html#type-t">Event.t</a> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?status</span>:<a href="#type-status">status</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">trace_id</span>:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?parent</span>:<a href="#type-id">id</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?links</span>:<span><a href="../Span_link/index.html#type-t">Span_link.t</a> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">start_time</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">end_time</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a> * <a href="#type-id">id</a></span></code></div><div class="spec-doc"><p><code>create ~trace_id name</code> creates a new span with its unique ID.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">trace_id</span> <p>the trace this belongs to</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">parent</span> <p>parent span, if any</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">links</span> <p>list of links to other spans, each with their trace state (see <a href="https://www.w3.org/TR/trace-context/#tracestate-header">w3.org</a>)</p></li></ul></div></div></div></body></html>
|