mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-05 17:04:52 -04:00
11 lines
5.7 KiB
HTML
11 lines
5.7 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl_lwt (opentelemetry-client-ocurl-lwt.Opentelemetry_client_ocurl_lwt)</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-lwt</a> » Opentelemetry_client_ocurl_lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl_lwt</span></code></h1></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> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_consumer"><a href="#val-create_consumer" class="anchor"></a><code><span><span class="keyword">val</span> create_consumer :
|
||
<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>
|
||
<a href="../../opentelemetry-client/Opentelemetry_client/Consumer/index.html#type-any_signal_l_builder">Opentelemetry_client.Consumer.any_signal_l_builder</a></span></code></div><div class="spec-doc"><p>Consumer that pulls from a queue</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_exporter"><a href="#val-create_exporter" class="anchor"></a><code><span><span class="keyword">val</span> create_exporter : <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> <a href="../../opentelemetry/Opentelemetry/Exporter/index.html#type-t">Opentelemetry.Exporter.t</a></span></code></div><div class="spec-doc"><p>Create a new backend using lwt and ezcurl-lwt</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">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="../../opentelemetry/Opentelemetry/Exporter/index.html#type-t">Opentelemetry.Exporter.t</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use create_exporter</li></ul></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">?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 <code>Opentelemetry.Collector.backend</code>.</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></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> <span>unit <a href="../../lwt/Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Shutdown current backend</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.90</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">?after_shutdown</span>:<span>(<span><a href="../../opentelemetry/Opentelemetry/Exporter/index.html#type-t">Opentelemetry.Exporter.t</a> <span class="arrow">-></span></span> unit)</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><span class="type-var">'a</span> <a href="../../lwt/Lwt/index.html#type-t">Lwt.t</a></span>)</span> <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'a</span> <a href="../../lwt/Lwt/index.html#type-t">Lwt.t</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>
|