This commit is contained in:
mattjbray 2022-03-24 17:49:17 +00:00
parent 6361acb8dc
commit 1a06b1f473
3 changed files with 11 additions and 1 deletions

View file

@ -0,0 +1,8 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traceparent (opentelemetry.Opentelemetry.Trace_context.Traceparent)</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> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Trace_context</a> &#x00BB; Traceparent</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_context.Traceparent</span></code></h1><p>The traceparent header https://www.w3.org/TR/trace-context/#traceparent-header</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-name" class="anchored"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_value" class="anchored"><a href="#val-of_value" class="anchor"></a><code><span><span class="keyword">val</span> of_value : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>( <a href="../../Trace_id/index.html#type-t">Trace_id.t</a> * <a href="../../Span_id/index.html#type-t">Span_id.t</a>, string )</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p>Parse the value of the traceparent header.</p><p>The values are of the form:</p><pre>ersion}-{trace_id}-{parent_id}-{flags}
For example:
00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
{flags} are currently ignored.</pre></div></div><div class="odoc-spec"><div class="spec value" id="val-to_value" class="anchored"><a href="#val-to_value" class="anchor"></a><code><span><span class="keyword">val</span> to_value : <span>trace_id:<a href="../../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span> <span>parent_id:<a href="../../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_context (opentelemetry.Opentelemetry.Trace_context)</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> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Trace_context</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace_context</span></code></h1><p>Implementation of the W3C Trace Context spec</p><p>https://www.w3.org/TR/trace-context/</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module" id="module-Traceparent" class="anchored"><a href="#module-Traceparent" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Traceparent/index.html">Traceparent</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The traceparent header https://www.w3.org/TR/trace-context/#traceparent-header</p></div></div></div></body></html>

View file

@ -1,3 +1,3 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry (opentelemetry.Opentelemetry)</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> &#x00BB; Opentelemetry</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module" id="module-Proto" class="anchored"><a href="#module-Proto" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Proto/index.html">Proto</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Protobuf types</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Timestamp_ns" class="anchored"><a href="#module-Timestamp_ns" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Timestamp_ns/index.html">Timestamp_ns</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unix timestamp.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Collector" class="anchored"><a href="#module-Collector" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Collector/index.html">Collector</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector types</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Util_" class="anchored"><a href="#module-Util_" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Util_/index.html">Util_</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace_id" class="anchored"><a href="#module-Trace_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace_id/index.html">Trace_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Trace ID.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Span_id" class="anchored"><a href="#module-Span_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span_id/index.html">Span_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unique ID of a span.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Globals" class="anchored"><a href="#module-Globals" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Globals/index.html">Globals</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Process-wide metadata, environment variables, etc.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-key_value" class="anchored"><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>| `None</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Event" class="anchored"><a href="#module-Event" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Event/index.html">Event</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Events.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Span" class="anchored"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Spans.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace" class="anchored"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Traces.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics" class="anchored"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Metrics.</p></div></div></div></body></html>
string * <span>[ <span>`Int of int</span> <span><span>| `String</span> of string</span> <span><span>| `Bool</span> of bool</span> <span>| `None</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Event" class="anchored"><a href="#module-Event" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Event/index.html">Event</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Events.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Span" class="anchored"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Spans.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace" class="anchored"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Traces.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics" class="anchored"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Metrics.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace_context" class="anchored"><a href="#module-Trace_context" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace_context/index.html">Trace_context</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Implementation of the W3C Trace Context spec</p></div></div></div></body></html>