mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-05-06 01:15:11 -04:00
8 lines
6.2 KiB
HTML
8 lines
6.2 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Consumer (opentelemetry-client.Opentelemetry_client.Consumer)</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> » Consumer</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Consumer</span></code></h1><p>Consumer that accepts items from a bounded queue and processes them.</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><span> = </span><span>{</span></code><ol><li id="type-t.active" class="def record field anchored"><a href="#type-t.active" class="anchor"></a><code><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></li><li id="type-t.shutdown" class="def record field anchored"><a href="#type-t.shutdown" class="anchor"></a><code><span>shutdown : <span>unit <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Shutdown the consumer as soon as possible. <code>active</code> will be turned off once the consumer is fully shut down.</p><span class="comment-delim">*)</span></div></li><li id="type-t.tick" class="def record field anchored"><a href="#type-t.tick" class="anchor"></a><code><span>tick : <span>unit <span class="arrow">-></span></span> unit;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Regularly called, eg to emit metrics, check timeouts, etc. Must be thread safe.</p><span class="comment-delim">*)</span></div></li><li id="type-t.self_metrics" class="def record field anchored"><a href="#type-t.self_metrics" class="anchor"></a><code><span>self_metrics : <span><span class="label">clock</span>:<a href="../../../opentelemetry/Opentelemetry_core/Clock/index.html#type-t">Opentelemetry_client.Common_.OTEL.Clock.t</a> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<span><a href="../../../opentelemetry/Opentelemetry_core/Metrics/index.html#type-t">Opentelemetry_client.Common_.OTEL.Metrics.t</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Self observing metrics</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A consumer for signals of type <code>'a</code></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-consumer"><a href="#type-consumer" class="anchor"></a><code><span><span class="keyword">type</span> consumer</span><span> = <a href="#type-t">t</a></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><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../opentelemetry/Opentelemetry_util/Aswitch/index.html#type-t">Opentelemetry_util.Aswitch.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span><a href="#type-t">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><span class="label">clock</span>:<a href="../../../opentelemetry/Opentelemetry_core/Clock/index.html#type-t">Opentelemetry_client.Common_.OTEL.Clock.t</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../opentelemetry/Opentelemetry_core/Metrics/index.html#type-t">Opentelemetry_client.Common_.OTEL.Metrics.t</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_stop"><a href="#val-on_stop" class="anchor"></a><code><span><span class="keyword">val</span> on_stop : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>on_stop e f</code> calls <code>f()</code> when <code>e</code> stops, or now if it's already stopped</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Builder"><a href="#module-Builder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Builder/index.html">Builder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-any_signal_l_builder"><a href="#type-any_signal_l_builder" class="anchor"></a><code><span><span class="keyword">type</span> any_signal_l_builder</span><span> =
|
||
<span><a href="../../../opentelemetry/Opentelemetry_core/Any_signal_l/index.html#type-t">Opentelemetry_client.Common_.OTEL.Any_signal_l.t</a> <a href="Builder/index.html#type-t">Builder.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-resource_signal_builder"><a href="#type-resource_signal_builder" class="anchor"></a><code><span><span class="keyword">type</span> resource_signal_builder</span><span> = <span><a href="../Resource_signal/index.html#type-t">Resource_signal.t</a> <a href="Builder/index.html#type-t">Builder.t</a></span></span></code></div><div class="spec-doc"><p>The type that's useful for HTTP backends</p></div></div></div></body></html>
|