mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 04:17:56 -04:00
2 lines
3.9 KiB
HTML
2 lines
3.9 KiB
HTML
<!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 2.4.3"/><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> » <a href="../index.html">Debug_backend</a> » 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">-></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">-></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">-></span></span> unit)</span> <a href="../../../AList/index.html#type-t">AList.t</a></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 anchored" id="val-cleanup"><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>
|