ocaml-opentelemetry/opentelemetry/Opentelemetry/Trace_context/Traceparent/index.html
2024-09-20 16:15:07 +00:00

2 lines
2.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traceparent (opentelemetry.Opentelemetry.Trace_context.Traceparent)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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 anchored" id="val-name"><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 anchored" id="val-of_value"><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> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></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 class="language-ocaml"><code>{version}-{trace_id}-{parent_id}-{flags}</code></pre><p>For example:</p><pre class="language-ocaml"><code>00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 </code></pre><p><code>{flags}</code> are currently ignored.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_value"><a href="#val-to_value" class="anchor"></a><code><span><span class="keyword">val</span> to_value : <span><span class="label">trace_id</span>:<a href="../../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">parent_id</span>:<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>