mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-07 18:37:56 -05:00
17 lines
6.3 KiB
HTML
17 lines
6.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</a> » <a href="../index.html">opentelemetry-client-ocurl</a> » Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><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">-></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">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set http headers that are sent on every http query to the collector.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html">Opentelemetry_atomic.Atomic</a></span></code></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>Configuration for the ocurl backend</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-n_bytes_sent"><a href="#val-n_bytes_sent" class="anchor"></a><code><span><span class="keyword">val</span> n_bytes_sent : <span>unit <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Global counter of bytes sent (or attempted to be sent)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_backend"><a href="#val-create_backend" class="anchor"></a><code><span><span class="keyword">val</span> create_backend :
|
||
<span><span class="optlabel">?stop</span>:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span>(<span class="keyword">module</span> <a href="../../opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html">Opentelemetry.Collector.BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup :
|
||
<span><span class="optlabel">?stop</span>:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?enable</span>:bool <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Setup endpoint. This modifies <a href="../../opentelemetry/Opentelemetry/Collector/index.html#type-backend"><code>Opentelemetry.Collector.backend</code></a>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">enable</span> <p>actually setup the backend (default true). This can be used to enable/disable the setup depending on CLI arguments or environment.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to use</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">stop</span> <p>an atomic boolean. When it becomes true, background threads will all stop after a little while.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_backend"><a href="#val-remove_backend" class="anchor"></a><code><span><span class="keyword">val</span> remove_backend : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.12</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup :
|
||
<span><span class="optlabel">?stop</span>:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?enable</span>:bool <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span><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></div><div class="spec-doc"><p><code>with_setup () f</code> is like <code>setup(); f()</code> but takes care of cleaning up after <code>f()</code> returns See <a href="#val-setup"><code>setup</code></a> for more details.</p></div></div></div></body></html>
|