simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-09 12:23:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: dd66852113

Browse source
This commit is contained in:
c-cube 2025-06-11 18:41:19 +00:00
parent e51c86ad7d
commit ba41df1096
10 changed files with 65 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/Env/index.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Env (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config.Env)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../../../index.html">opentelemetry-client-ocurl</a> &#x00BB; <a href="../../index.html">Opentelemetry_client_ocurl</a> &#x00BB; <a href="../index.html">Config</a> &#x00BB; Env</nav><header class="odoc-preamble"><h1>Module <code><span>Config.Env</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-get_debug"><a href="#val-get_debug" class="anchor"></a><code><span><span class="keyword">val</span> get_debug : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_debug"><a href="#val-set_debug" class="anchor"></a><code><span><span class="keyword">val</span> set_debug : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_headers"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_headers"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
<span><span>(<span><a href="../../../../opentelemetry/Opentelemetry_client/Config/index.html#type-t">Opentelemetry_client.Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <a href="../../../../opentelemetry/Opentelemetry_client/Config/index.html#type-make">Opentelemetry_client.Config.make</a></span></span></code></div><div class="spec-doc"><p><code>make f</code> is a <code>make</code> function that will give <code>f</code> a safely constructed <a href="../index.html#type-t"><code>t</code></a>.</p><p>Typically this is used to extend the constructor for <a href="../index.html#type-t"><code>t</code></a> with new optional arguments.</p><p>E.g., we can construct a configuration that includes a <a href="../index.html#type-t"><code>t</code></a> alongside a more specific field like so:</p><pre class="language-ocaml"><code> type extended_config = {
new_field: string;
common: t;
}
let make : (new_field:string -&gt; unit -&gt; extended_config) make =
Env.make (fun common ~new_field () -&gt; { new_field; common })
let _example : extended_config =
make ~new_field:&quot;foo&quot; ~url_traces:&quot;foo/bar&quot; ~debug:true ()</code></pre><p>As a special case, we can get the simple constructor function for <a href="../index.html#type-t"><code>t</code></a> with <code>Env.make (fun common () -&gt; common)</code></p></div></div></div></body></html>

21
opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html
View file

File diff suppressed because one or more lines are too long

2
opentelemetry/Opentelemetry_client/Client/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Client (opentelemetry.Opentelemetry_client.Client)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry_client</a> &#x00BB; Client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Client</span></code></h1><p>Utilities for writing clients</p><p>These are used for implementing e.g., the <code>opentelemetry-client-cohttp-lwt</code> and <code>opentelemetry-client-ocurl</code> packages package.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> Config</span><span> = <a href="../Config/index.html">Config</a></span></code></div></div></div></body></html>

11
opentelemetry/Opentelemetry_client/Config/Env/index.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Env (opentelemetry.Opentelemetry_client.Config.Env)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../../../index.html">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry_client</a> &#x00BB; <a href="../index.html">Config</a> &#x00BB; Env</nav><header class="odoc-preamble"><h1>Module <code><span>Config.Env</span></code></h1><p>A generative functor that produces a state-space that can read configuration values from the environment, provide stateful configuration setting and accessing operations, and a way to make a new <a href="../index.html#type-t"><code>t</code></a> configuration record</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav></div><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-get_debug"><a href="#val-get_debug" class="anchor"></a><code><span><span class="keyword">val</span> get_debug : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_debug"><a href="#val-set_debug" class="anchor"></a><code><span><span class="keyword">val</span> set_debug : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_headers"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_headers"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span>(<span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-make">make</a></span></span></code></div><div class="spec-doc"><p><code>make f</code> is a <a href="../index.html#type-make"><code>make</code></a> function that will give <code>f</code> a safely constructed <a href="../index.html#type-t"><code>t</code></a>.</p><p>Typically this is used to extend the constructor for <a href="../index.html#type-t"><code>t</code></a> with new optional arguments.</p><p>E.g., we can construct a configuration that includes a <a href="../index.html#type-t"><code>t</code></a> alongside a more specific field like so:</p><pre class="language-ocaml"><code> type extended_config = {
new_field: string;
common: t;
}
let make : (new_field:string -&gt; unit -&gt; extended_config) make =
Env.make (fun common ~new_field () -&gt; { new_field; common })
let _example : extended_config =
make ~new_field:&quot;foo&quot; ~url_traces:&quot;foo/bar&quot; ~debug:true ()</code></pre><p>As a special case, we can get the simple constructor function for <a href="../index.html#type-t"><code>t</code></a> with <code>Env.make (fun common () -&gt; common)</code></p></div></div></div></body></html>

14
opentelemetry/Opentelemetry_client/Config/index.html Normal file
View file

File diff suppressed because one or more lines are too long

11
opentelemetry/Opentelemetry_client/Config/module-type-ENV/index.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ENV (opentelemetry.Opentelemetry_client.Config.ENV)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../../../index.html">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry_client</a> &#x00BB; <a href="../index.html">Config</a> &#x00BB; ENV</nav><header class="odoc-preamble"><h1>Module type <code><span>Config.ENV</span></code></h1><p>Construct, inspect, and update <a href="../index.html#type-t"><code>t</code></a> configurations, drawing defaults from the environment and encapsulating state</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-get_debug"><a href="#val-get_debug" class="anchor"></a><code><span><span class="keyword">val</span> get_debug : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_debug"><a href="#val-set_debug" class="anchor"></a><code><span><span class="keyword">val</span> set_debug : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_headers"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_headers"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span>(<span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-make">make</a></span></span></code></div><div class="spec-doc"><p><code>make f</code> is a <a href="../index.html#type-make"><code>make</code></a> function that will give <code>f</code> a safely constructed <a href="../index.html#type-t"><code>t</code></a>.</p><p>Typically this is used to extend the constructor for <a href="../index.html#type-t"><code>t</code></a> with new optional arguments.</p><p>E.g., we can construct a configuration that includes a <a href="../index.html#type-t"><code>t</code></a> alongside a more specific field like so:</p><pre class="language-ocaml"><code> type extended_config = {
new_field: string;
common: t;
}
let make : (new_field:string -&gt; unit -&gt; extended_config) make =
Env.make (fun common ~new_field () -&gt; { new_field; common })
let _example : extended_config =
make ~new_field:&quot;foo&quot; ~url_traces:&quot;foo/bar&quot; ~debug:true ()</code></pre><p>As a special case, we can get the simple constructor function for <a href="../index.html#type-t"><code>t</code></a> with <code>Env.make (fun common () -&gt; common)</code></p></div></div></div></body></html>

2
opentelemetry/Opentelemetry_client/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client (opentelemetry.Opentelemetry_client)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../index.html">opentelemetry</a> &#x00BB; Opentelemetry_client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Client"><a href="#module-Client" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Client/index.html">Client</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utilities for writing clients</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Constructing and managing the configuration needed in common by all clients</p></div></div></div></body></html>

2
opentelemetry/Opentelemetry_client__Client/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client__Client (opentelemetry.Opentelemetry_client__Client)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../index.html">opentelemetry</a> &#x00BB; Opentelemetry_client__Client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client__Client</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
opentelemetry/Opentelemetry_client__Config/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client__Config (opentelemetry.Opentelemetry_client__Config)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../index.html">opentelemetry</a> &#x00BB; Opentelemetry_client__Config</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client__Config</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>

2
opentelemetry/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (opentelemetry.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; opentelemetry</nav><header class="odoc-preamble"><h1 id="package-opentelemetry"><a href="#package-opentelemetry" class="anchor"></a>Package opentelemetry <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Opentelemetry/index.html"><code>Opentelemetry</code></a> <span class="synopsis">Opentelemetry types and instrumentation</span></li><li><a href="Opentelemetry_ambient_context/index.html"><code>Opentelemetry_ambient_context</code></a> <span class="synopsis">Ambient context.</span></li><li><a href="Opentelemetry_ambient_context_lwt/index.html"><code>Opentelemetry_ambient_context_lwt</code></a> </li><li><a href="Opentelemetry_ambient_context_types/index.html"><code>Opentelemetry_ambient_context_types</code></a> <span class="synopsis">Storage implementation.</span></li><li><a href="Opentelemetry_atomic/index.html"><code>Opentelemetry_atomic</code></a> </li><li><a href="Opentelemetry_proto/index.html"><code>Opentelemetry_proto</code></a> </li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (opentelemetry.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; opentelemetry</nav><header class="odoc-preamble"><h1 id="package-opentelemetry"><a href="#package-opentelemetry" class="anchor"></a>Package opentelemetry <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><ul class="modules"><li><a href="Opentelemetry/index.html"><code>Opentelemetry</code></a> <span class="synopsis">Opentelemetry types and instrumentation</span></li><li><a href="Opentelemetry_ambient_context/index.html"><code>Opentelemetry_ambient_context</code></a> <span class="synopsis">Ambient context.</span></li><li><a href="Opentelemetry_ambient_context_lwt/index.html"><code>Opentelemetry_ambient_context_lwt</code></a> </li><li><a href="Opentelemetry_ambient_context_types/index.html"><code>Opentelemetry_ambient_context_types</code></a> <span class="synopsis">Storage implementation.</span></li><li><a href="Opentelemetry_atomic/index.html"><code>Opentelemetry_atomic</code></a> </li><li><a href="Opentelemetry_client/index.html"><code>Opentelemetry_client</code></a> </li><li><a href="Opentelemetry_proto/index.html"><code>Opentelemetry_proto</code></a> </li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>