mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 04:17:56 -04:00
16 lines
9.1 KiB
HTML
16 lines
9.1 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-sender"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><ol><li id="type-sender.send" class="def record field anchored"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">-></span></span> <span><span class="label">ret</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></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>) but without <code>over</code> as it doesn't make much sense in presence of batching.</p><p>The <code>ret</code> callback is used to return the desired type (unit, or a Lwt promise, or anything else) once the event has been transferred to the backend. It doesn't mean the event has been collected yet, it could sit in a batch queue for a little while.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-BACKEND"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-backend"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Noop_backend"><a href="#module-Noop_backend" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Noop_backend/index.html">Noop_backend</a></span><span> : <a href="module-type-BACKEND/index.html">BACKEND</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Debug_backend"><a href="#module-Debug_backend" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Debug_backend/index.html">Debug_backend</a></span><span> (<a href="Debug_backend/argument-1-B/index.html">B</a> : <a href="module-type-BACKEND/index.html">BACKEND</a>) : <a href="module-type-BACKEND/index.html">BACKEND</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug_backend"><a href="#val-debug_backend" class="anchor"></a><code><span><span class="keyword">val</span> debug_backend : <a href="#type-backend">backend</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_backend"><a href="#val-set_backend" class="anchor"></a><code><span><span class="keyword">val</span> set_backend : <span><a href="#type-backend">backend</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set collector backend</p></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">-></span></span> unit</span></code></div><div class="spec-doc"><p>Remove current backend, if any.</p><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-has_backend"><a href="#val-has_backend" class="anchor"></a><code><span><span class="keyword">val</span> has_backend : <span>unit <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is there a configured backend?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_backend"><a href="#val-get_backend" class="anchor"></a><code><span><span class="keyword">val</span> get_backend : <span>unit <span class="arrow">-></span></span> <span><a href="#type-backend">backend</a> option</span></span></code></div><div class="spec-doc"><p>Current backend, if any</p></div></div><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> <span class="arrow">-></span></span>
|
||
<span><span class="label">ret</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><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> <span class="arrow">-></span></span>
|
||
<span><span class="label">ret</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><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> <span class="arrow">-></span></span>
|
||
<span><span class="label">ret</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><div class="odoc-spec"><div class="spec value anchored" id="val-rand_bytes_16"><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><div class="odoc-spec"><div class="spec value anchored" id="val-rand_bytes_8"><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><div class="odoc-spec"><div class="spec value anchored" id="val-on_tick"><a href="#val-on_tick" class="anchor"></a><code><span><span class="keyword">val</span> on_tick : <span><span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></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>Do background work. Call this regularly if the collector doesn't already have a ticker thread or internal timer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup_debug_backend"><a href="#val-with_setup_debug_backend" class="anchor"></a><code><span><span class="keyword">val</span> with_setup_debug_backend :
|
||
<span><a href="#type-backend">backend</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?enable</span>:bool <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<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></div></body></html>
|