mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-05 08:54:27 -04:00
28 lines
9.7 KiB
HTML
28 lines
9.7 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sdk (opentelemetry-lwt.Opentelemetry_lwt.Sdk)</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-lwt</a> » <a href="../index.html">Opentelemetry_lwt</a> » Sdk</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Sdk</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Sdk/index.html">Opentelemetry.Sdk</a> <span class="keyword">end</span></span></code></summary><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Sdk/index.html">Opentelemetry.Sdk</a> <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-present"><a href="#val-present" class="anchor"></a><code><span><span class="keyword">val</span> present : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span>unit <span class="arrow">-></span></span> <span><a href="../../../opentelemetry/Opentelemetry_core/Exporter/index.html#type-t">Opentelemetry_core.Exporter.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-active"><a href="#val-active" class="anchor"></a><code><span><span class="keyword">val</span> active : <span>unit <span class="arrow">-></span></span> <a href="../../../opentelemetry/Opentelemetry_util/Aswitch/index.html#type-t">Opentelemetry_util.Aswitch.t</a></span></code></div><div class="spec-doc"><p>Aswitch of the installed exporter, or <a href="../../../opentelemetry/Opentelemetry_util/Aswitch/index.html#val-dummy"><code>Aswitch.dummy</code></a> if none.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_on_tick_callback"><a href="#val-add_on_tick_callback" class="anchor"></a><code><span><span class="keyword">val</span> add_on_tick_callback : <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run_tick_callbacks"><a href="#val-run_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> run_tick_callbacks : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tick"><a href="#val-tick" class="anchor"></a><code><span><span class="keyword">val</span> tick : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Tick all providers and run all registered callbacks. Call this periodically (e.g. every 500ms) to drive metrics collection, GC metrics, and batch timeout flushing. This is the single function client libraries should call from their ticker.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set :
|
||
<span><span class="optlabel">?traces</span>:<a href="../../../opentelemetry/Opentelemetry/Provider_config/index.html#type-t">Opentelemetry.Provider_config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?metrics</span>:<a href="../../../opentelemetry/Opentelemetry/Provider_config/index.html#type-t">Opentelemetry.Provider_config.t</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?logs</span>:<a href="../../../opentelemetry/Opentelemetry/Provider_config/index.html#type-t">Opentelemetry.Provider_config.t</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../opentelemetry/Opentelemetry_core/Exporter/index.html#type-t">Opentelemetry_core.Exporter.t</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-self_metrics"><a href="#val-self_metrics" class="anchor"></a><code><span><span class="keyword">val</span> self_metrics : <span>unit <span class="arrow">-></span></span> <span><a href="../../../opentelemetry/Opentelemetry_core/Metrics/index.html#type-t">Opentelemetry_core.Metrics.t</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setup_self_metrics"><a href="#val-setup_self_metrics" class="anchor"></a><code><span><span class="keyword">val</span> setup_self_metrics : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Regularly emit metrics about the OTEL SDK. Idempotent.</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_tracer"><a href="#val-get_tracer" class="anchor"></a><code><span><span class="keyword">val</span> get_tracer :
|
||
<span><span class="optlabel">?name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?version</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?attrs</span>:<span><span>(string * <span>[< <a href="../../../opentelemetry/Opentelemetry_core/Value/index.html#type-t">Opentelemetry_core.Value.t</a> ]</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?__MODULE__</span>:string <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="../../../opentelemetry/Opentelemetry/Tracer/index.html#type-t">Opentelemetry.Tracer.t</a></span></code></div><div class="spec-doc"><p>Get a tracer forwarding to the current main exporter.</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-get_meter"><a href="#val-get_meter" class="anchor"></a><code><span><span class="keyword">val</span> get_meter :
|
||
<span><span class="optlabel">?name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?version</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?attrs</span>:<span><span>(string * <span>[< <a href="../../../opentelemetry/Opentelemetry_core/Value/index.html#type-t">Opentelemetry_core.Value.t</a> ]</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?__MODULE__</span>:string <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="../../../opentelemetry/Opentelemetry/Meter/index.html#type-t">Opentelemetry.Meter.t</a></span></code></div><div class="spec-doc"><p>Get a meter forwarding to the current main exporter.</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-get_logger"><a href="#val-get_logger" class="anchor"></a><code><span><span class="keyword">val</span> get_logger :
|
||
<span><span class="optlabel">?name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?version</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?attrs</span>:<span><span>(string * <span>[< <a href="../../../opentelemetry/Opentelemetry_core/Value/index.html#type-t">Opentelemetry_core.Value.t</a> ]</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?__MODULE__</span>:string <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="../../../opentelemetry/Opentelemetry/Logger/index.html#type-t">Opentelemetry.Logger.t</a></span></code></div><div class="spec-doc"><p>Get a logger forwarding to the current main exporter.</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-self_debug_to_stderr"><a href="#val-self_debug_to_stderr" class="anchor"></a><code><span><span class="keyword">val</span> self_debug_to_stderr :
|
||
<span><span class="optlabel">?min_level</span>:<a href="../../../opentelemetry/Opentelemetry/Self_debug/index.html#type-level">Opentelemetry.Self_debug.level</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
unit</span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <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></div></body></html>
|