simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-10 20:48:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

deploy: 92de45a2ec

Browse source
This commit is contained in:
c-cube 2025-05-05 18:48:08 +00:00
parent b56e2cf027
commit e0204e424d
8 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html
View file

@ -8,7 +8,7 @@
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?enable</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</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-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup :
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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</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">&#45;&gt;</span></span>
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?enable</span>:bool <span class="arrow">&#45;&gt;</span></span>

17
opentelemetry-cohttp-lwt/Opentelemetry_cohttp_lwt/Server/index.html
View file

@ -9,15 +9,14 @@
<span><span class="type-var">'conn</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../cohttp/Cohttp/Request/index.html#type-t">Cohttp_lwt.Request.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'body</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../../../cohttp/Cohttp/Response/index.html#type-t">Cohttp_lwt.Response.t</a> * <span class="type-var">'body</span>)</span> <a href="../../../lwt/Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Trace requests to a Cohttp server.</p><p>Use it like this:</p><pre class="language-ocaml"><code>let my_server callback =
let callback_traced =
Opentelemetry_cohttp_lwt.Server.trace
~service_name:&quot;my-service&quot;
(fun _scope -&gt; callback)
in
Cohttp_lwt_unix.Server.create
~mode:(`TCP (`Port 8080))
(Server.make () ~callback:callback_traced)</code></pre></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
<span><span>(<a href="../../../cohttp/Cohttp/Response/index.html#type-t">Cohttp_lwt.Response.t</a> * <span class="type-var">'body</span>)</span> <a href="../../../lwt/Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Trace requests to a Cohttp server.</p><p>Use it like this:</p><pre class="language-ocaml"><code> let my_server callback =
let callback_traced =
Opentelemetry_cohttp_lwt.Server.trace ~service_name:&quot;my-service&quot;
(fun _scope -&gt; callback)
in
Cohttp_lwt_unix.Server.create
~mode:(`TCP (`Port 8080))
(Server.make () ~callback:callback_traced)</code></pre></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
<span><span class="optlabel">?trace_state</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?service_name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?attrs</span>:<span><a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-key_value">Otel.Span.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>

2
opentelemetry/Opentelemetry/Collector/Debug_backend/argument-1-B/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)</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</a> &#x00BB; <a href="../../index.html">Collector</a> &#x00BB; <a href="../index.html">Debug_backend</a> &#x00BB; B</nav><header class="odoc-preamble"><h1>Parameter <code><span>Debug_backend.B</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)</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</a> &#x00BB; <a href="../../index.html">Collector</a> &#x00BB; <a href="../index.html">Debug_backend</a> &#x00BB; B</nav><header class="odoc-preamble"><h1>Parameter <code><span>Debug_backend.B</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>

2
opentelemetry/Opentelemetry/Collector/Debug_backend/index.html
View file

File diff suppressed because one or more lines are too long

2
opentelemetry/Opentelemetry/Collector/Noop_backend/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)</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</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; Noop_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Collector.Noop_backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)</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</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; Noop_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Collector.Noop_backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>

3
opentelemetry/Opentelemetry/Collector/index.html
View file

File diff suppressed because one or more lines are too long

2
opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</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</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; BACKEND</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.BACKEND</span></code></h1><p>Collector client interface.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</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</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; BACKEND</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.BACKEND</span></code></h1><p>Collector client interface.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_metrics"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></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">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_on_tick_callbacks"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cleanup"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>

2
opentelemetry/Opentelemetry/Trace_context/Traceparent/index.html
View file

@ -1,5 +1,5 @@
<!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 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</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 :
<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 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</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="optlabel">?sampled</span>:bool <span class="arrow">&#45;&gt;</span></span>
<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>