mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-06 01:15:11 -04:00
2 lines
2.9 KiB
HTML
2 lines
2.9 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sampler (opentelemetry-client.Opentelemetry_client.Sampler)</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</a> » <a href="../index.html">Opentelemetry_client</a> » Sampler</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Sampler</span></code></h1><p>Basic random sampling.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span><span class="label">proba_accept</span>:float <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ~proba_accept:n ()</code> makes a new sampler.</p><p>The sampler will accept signals with probability <code>n</code> (must be between 0 and 1).</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>n</code> is not between 0 and 1.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-accept"><a href="#val-accept" class="anchor"></a><code><span><span class="keyword">val</span> accept : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Do we accept a sample? This returns <code>true</code> with probability <code>proba_accept</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-proba_accept"><a href="#val-proba_accept" class="anchor"></a><code><span><span class="keyword">val</span> proba_accept : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-actual_rate"><a href="#val-actual_rate" class="anchor"></a><code><span><span class="keyword">val</span> actual_rate : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> float</span></code></div><div class="spec-doc"><p>The ratio of signals we actually accepted so far. This should asymptotically be equal to <a href="#val-proba_accept"><code>proba_accept</code></a> if the random generator is good.</p></div></div></div></body></html>
|