mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-08 20:07:55 -04:00
deploy: 35ae22746d
This commit is contained in:
c-cube
parent
da014b0c38
commit
4a3ea378be
4 changed files with 6 additions and 2 deletions
|
|
@ -1,2 +1,2 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../../index.html">Opentelemetry</a> » <a href="../index.html">Collector</a> » 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" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../Proto/Trace/index.html#type-resource_spans">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" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../Proto/Metrics/index.html#type-resource_metrics">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" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span>unit <span class="arrow">-></span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span>unit <span class="arrow">-></span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-signal_emit_gc_metrics" class="anchored"><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">-></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" id="val-tick" class="anchored"><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>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_on_tick_callbacks" class="anchored"><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>( <span>unit <span class="arrow">-></span></span> unit )</span> list</span> <span class="xref-unresolved">Stdlib</span>.ref</span> <span class="arrow">-></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" id="val-cleanup" class="anchored"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">-></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><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../../index.html">Opentelemetry</a> » <a href="../index.html">Collector</a> » 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" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../Proto/Trace/index.html#type-resource_spans">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" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../Proto/Metrics/index.html#type-resource_metrics">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" id="val-signal_emit_gc_metrics" class="anchored"><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">-></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" id="val-tick" class="anchored"><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>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_on_tick_callbacks" class="anchored"><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>( <span>unit <span class="arrow">-></span></span> unit )</span> list</span> <span class="xref-unresolved">Stdlib</span>.ref</span> <span class="arrow">-></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" id="val-cleanup" class="anchored"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||||
2
dev/opentelemetry/Opentelemetry/Lock/index.html
Normal file
2
dev/opentelemetry/Opentelemetry/Lock/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lock (opentelemetry.Opentelemetry.Lock)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Lock</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Lock</span></code></h1><p>Global lock</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-set_mutex" class="anchored"><a href="#val-set_mutex" class="anchor"></a><code><span><span class="keyword">val</span> set_mutex : <span>lock:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span> <span>unlock:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set a pair of lock/unlock functions that are used to protect access to global state, if needed. By default these do nothing.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_lock" class="anchored"><a href="#val-with_lock" class="anchor"></a><code><span><span class="keyword">val</span> with_lock : <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>Call <code>f()</code> while holding the mutex defined <a href="#val-set_mutex"><code>set_mutex</code></a>, then release the mutex.</p></div></div></div></body></html>
|
||||||
2
dev/opentelemetry/Opentelemetry/Rand_bytes/index.html
Normal file
2
dev/opentelemetry/Opentelemetry/Rand_bytes/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Rand_bytes (opentelemetry.Opentelemetry.Rand_bytes)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Rand_bytes</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Rand_bytes</span></code></h1><p>Generation of random identifiers</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span><span>( <span>unit <span class="arrow">-></span></span> bytes )</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span><span>( <span>unit <span class="arrow">-></span></span> bytes )</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-default_rand_bytes_8" class="anchored"><a href="#val-default_rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> default_rand_bytes_8 : <span>unit <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-default_rand_bytes_16" class="anchored"><a href="#val-default_rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> default_rand_bytes_16 : <span>unit <span class="arrow">-></span></span> bytes</span></code></div></div></div></body></html>
|
||||||
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue