simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-05-05 17:04:52 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-opentelemetry/opentelemetry-client/Opentelemetry_client/index.html
c-cube b76bf492b9 deploy: b766f86019
2026-04-06 19:57:49 +00:00

2 lines
10 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client (opentelemetry-client.Opentelemetry_client)</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> &#x00BB; <a href="../index.html">opentelemetry-client</a> &#x00BB; Opentelemetry_client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Bounded_queue"><a href="#module-Bounded_queue" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Bounded_queue/index.html">Bounded_queue</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Interface for a thread-safe, bounded queue.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Common_"><a href="#module-Common_" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Common_/index.html">Common_</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Consumer"><a href="#module-Consumer" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Consumer/index.html">Consumer</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Consumer that accepts items from a bounded queue and processes them.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Emitter_combine"><a href="#module-Emitter_combine" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Emitter_combine/index.html">Emitter_combine</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Combine multiple emitters into one.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Emitter_limit_interval"><a href="#module-Emitter_limit_interval" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Emitter_limit_interval/index.html">Emitter_limit_interval</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Limit frequency at which the emitter emits.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Emitter_sample"><a href="#module-Emitter_sample" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Emitter_sample/index.html">Emitter_sample</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Export_error"><a href="#module-Export_error" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Export_error/index.html">Export_error</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Error that can occur during export</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter_combine"><a href="#module-Exporter_combine" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter_combine/index.html">Exporter_combine</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Combine multiple exporters into one</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter_config"><a href="#module-Exporter_config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter_config/index.html">Exporter_config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Constructing and managing the configuration common to many (most?) HTTP-based clients.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter_debug"><a href="#module-Exporter_debug" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter_debug/index.html">Exporter_debug</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Basic debug exporter, prints signals on stdout/stderr/...</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter_queued"><a href="#module-Exporter_queued" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter_queued/index.html">Exporter_queued</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Build an exporter from a queue and a consumer.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter_stdout"><a href="#module-Exporter_stdout" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter_stdout/index.html">Exporter_stdout</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A simple exporter that prints on stdout.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Generic_consumer"><a href="#module-Generic_consumer" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Generic_consumer/index.html">Generic_consumer</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A consumer: pulls signals from a queue, sends them somewhere else</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Generic_consumer_exporter"><a href="#module-Generic_consumer_exporter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Generic_consumer_exporter/index.html">Generic_consumer_exporter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A consumer that just calls another exporter.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Generic_http_consumer"><a href="#module-Generic_http_consumer" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Generic_http_consumer/index.html">Generic_http_consumer</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Generic_io"><a href="#module-Generic_io" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Generic_io/index.html">Generic_io</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Generic IO monad.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Generic_notifier"><a href="#module-Generic_notifier" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Generic_notifier/index.html">Generic_notifier</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Generic notifier (used to signal when a bounded queue is empty)</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Http_config"><a href="#module-Http_config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Http_config/index.html">Http_config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Resource_signal"><a href="#module-Resource_signal" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Resource_signal/index.html">Resource_signal</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Constructing and managing OTel <a href="https://opentelemetry.io/docs/concepts/signals/">signals</a> at the resource (batch) level</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Sampler"><a href="#module-Sampler" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Sampler/index.html">Sampler</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Basic random sampling.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Self_trace"><a href="#module-Self_trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Self_trace/index.html">Self_trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Mini tracing module for OTEL itself.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Util_net_backoff"><a href="#module-Util_net_backoff" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Util_net_backoff/index.html">Util_net_backoff</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Backoff behavior in case of errors</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Util_resources"><a href="#module-Util_resources" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Util_resources/index.html">Util_resources</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Group signals into <code>resource_xxx</code> objects</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink