mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
deploy: 341c70f18f
This commit is contained in:
c-cube
parent
24a0da7dcc
commit
d54cbafb6f
3 changed files with 3 additions and 3 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry-lwt.Opentelemetry_lwt.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry-lwt</a> » <a href="../index.html">Opentelemetry_lwt</a> » Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Trace</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Trace/index.html">Opentelemetry.Trace</a> <span class="keyword">end</span></span></code></summary><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-t">Opentelemetry.Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-scope" class="anchored"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = <a href="../../../opentelemetry/Opentelemetry/Trace/index.html#type-scope">Opentelemetry.Trace.scope</a></span><span> = </span><span>{</span></code><table><tr id="type-scope.trace_id" class="anchored"><td class="def record field"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a>;</span></code></td></tr><tr id="type-scope.span_id" class="anchored"><td class="def record field"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a>;</span></code></td></tr><tr id="type-scope.events" class="anchored"><td class="def record field"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../../../opentelemetry/Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> list</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Scope to be used with <a href="#val-with_"><code>with_</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-add_event" class="anchored"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span><a href="../../../opentelemetry/Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add an event to the scope. It will be aggregated into the span</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">-></span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit asynchronously</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry-lwt.Opentelemetry_lwt.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry-lwt</a> » <a href="../index.html">Opentelemetry_lwt</a> » Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Trace</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Trace/index.html">Opentelemetry.Trace</a> <span class="keyword">end</span></span></code></summary><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-t">Opentelemetry.Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-scope" class="anchored"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = <a href="../../../opentelemetry/Opentelemetry/Trace/index.html#type-scope">Opentelemetry.Trace.scope</a></span><span> = </span><span>{</span></code><table><tr id="type-scope.trace_id" class="anchored"><td class="def record field"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a>;</span></code></td></tr><tr id="type-scope.span_id" class="anchored"><td class="def record field"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a>;</span></code></td></tr><tr id="type-scope.events" class="anchored"><td class="def record field"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../../../opentelemetry/Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> list</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Scope to be used with <a href="#val-with_"><code>with_</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-add_event" class="anchored"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span><span>( <span>unit <span class="arrow">-></span></span> <a href="../../../opentelemetry/Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> )</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add an event to the scope. It will be aggregated into the span.</p><p>Note that this takes a function that produces an event, and will only call it if there is an instrumentation backend.</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">-></span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit asynchronously</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-key_value">Span.key_value</a> list</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-sender" class="anchored"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><table><tr id="type-sender.send" class="anchored"><td class="def record field"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">-></span></span> <span>over:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span> )</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>)</p></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-BACKEND" class="anchored"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-backend" class="anchored"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-backend" class="anchored"><a href="#val-backend" class="anchor"></a><code><span><span class="keyword">val</span> backend : <span><span><a href="#type-backend">backend</a> option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-sender" class="anchored"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><table><tr id="type-sender.send" class="anchored"><td class="def record field"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">-></span></span> <span>over:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span> )</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>)</p></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-BACKEND" class="anchored"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-backend" class="anchored"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-backend" class="anchored"><a href="#val-backend" class="anchor"></a><code><span><span class="keyword">val</span> backend : <span><span><a href="#type-backend">backend</a> option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-has_backend" class="anchored"><a href="#val-has_backend" class="anchor"></a><code><span><span class="keyword">val</span> has_backend : <span>unit <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is there a configured backend?</p></div></div><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace :
|
||||
<span><span><a href="../Proto/Trace/index.html#type-resource_spans">Proto.Trace.resource_spans</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>over:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span>
|
||||
<span>ret:<span>( <span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span> )</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry.Opentelemetry.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace</span></code></h1><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../Span/index.html#type-t">Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Sync emitter</p></div></div><div class="odoc-spec"><div class="spec type" id="type-scope" class="anchored"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = </span><span>{</span></code><table><tr id="type-scope.trace_id" class="anchored"><td class="def record field"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../Trace_id/index.html#type-t">Trace_id.t</a>;</span></code></td></tr><tr id="type-scope.span_id" class="anchored"><td class="def record field"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../Span_id/index.html#type-t">Span_id.t</a>;</span></code></td></tr><tr id="type-scope.events" class="anchored"><td class="def record field"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../Event/index.html#type-t">Event.t</a> list</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Scope to be used with <a href="#val-with_"><code>with_</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-add_event" class="anchored"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span><a href="../Event/index.html#type-t">Event.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add an event to the scope. It will be aggregated into the span</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry.Opentelemetry.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace</span></code></h1><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../Span/index.html#type-t">Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Sync emitter</p></div></div><div class="odoc-spec"><div class="spec type" id="type-scope" class="anchored"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = </span><span>{</span></code><table><tr id="type-scope.trace_id" class="anchored"><td class="def record field"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../Trace_id/index.html#type-t">Trace_id.t</a>;</span></code></td></tr><tr id="type-scope.span_id" class="anchored"><td class="def record field"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../Span_id/index.html#type-t">Span_id.t</a>;</span></code></td></tr><tr id="type-scope.events" class="anchored"><td class="def record field"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../Event/index.html#type-t">Event.t</a> list</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Scope to be used with <a href="#val-with_"><code>with_</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-add_event" class="anchored"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span><span>( <span>unit <span class="arrow">-></span></span> <a href="../Event/index.html#type-t">Event.t</a> )</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add an event to the scope. It will be aggregated into the span.</p><p>Note that this takes a function that produces an event, and will only call it if there is an instrumentation backend.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><a href="../Span/index.html#type-key_value">Span.key_value</a> list</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue