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/Opentelemetry/index.html
c-cube b76bf492b9 deploy: b766f86019
2026-04-06 19:57:49 +00:00

2 lines
18 KiB
HTML
Raw 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 (opentelemetry.Opentelemetry)</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</a> &#x00BB; Opentelemetry</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry</span></code></h1><p>Main Opentelemetry API for libraries and user code.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#wire-format">Wire format</a></li><li><a href="#time">Time</a></li><li><a href="#export-signals-to-some-external-collector.">Export signals to some external collector.</a></li><li><a href="#identifiers">Identifiers</a></li><li><a href="#attributes-and-conventions">Attributes and conventions</a></li><li><a href="#global-settings">Global settings</a></li><li><a href="#traces-and-spans">Traces and Spans</a></li><li><a href="#traces">Traces</a></li><li><a href="#metrics">Metrics</a></li><li><a href="#logs">Logs</a></li><li><a href="#utils">Utils</a></li></ul></nav></div><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Core"><a href="#module-Core" class="anchor"></a><code><span><span class="keyword">module</span> Core</span><span> = <a href="../Opentelemetry_core/index.html">Opentelemetry_core</a></span></code></div><div class="spec-doc"><p>Core types and definitions</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Interval_limiter"><a href="#module-Interval_limiter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Interval_limiter/index.html">Interval_limiter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utility to limit the frequency of some event</p></div></div><h3 id="wire-format"><a href="#wire-format" class="anchor"></a>Wire format</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Proto"><a href="#module-Proto" class="anchor"></a><code><span><span class="keyword">module</span> Proto</span><span> = <a href="../Opentelemetry_proto/index.html">Opentelemetry_proto</a></span></code></div><div class="spec-doc"><p>Protobuf types.</p></div></div><h3 id="time"><a href="#time" class="anchor"></a>Time</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Clock"><a href="#module-Clock" class="anchor"></a><code><span><span class="keyword">module</span> Clock</span><span> = <a href="../Opentelemetry_core/Clock/index.html">Opentelemetry_core.Clock</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Timestamp_ns"><a href="#module-Timestamp_ns" class="anchor"></a><code><span><span class="keyword">module</span> Timestamp_ns</span><span> = <a href="../Opentelemetry_core/Timestamp_ns/index.html">Opentelemetry_core.Timestamp_ns</a></span></code></div></div><h3 id="export-signals-to-some-external-collector."><a href="#export-signals-to-some-external-collector." class="anchor"></a>Export signals to some external collector.</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Emitter"><a href="#module-Emitter" class="anchor"></a><code><span><span class="keyword">module</span> Emitter</span><span> = <a href="../Opentelemetry_emitter/Emitter/index.html">Opentelemetry_emitter.Emitter</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exporter"><a href="#module-Exporter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exporter/index.html">Exporter</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-Sdk"><a href="#module-Sdk" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Sdk/index.html">Sdk</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-Main_exporter"><a href="#module-Main_exporter" class="anchor"></a><code><span><span class="keyword">module</span> Main_exporter</span><span> = <a href="Sdk/index.html">Sdk</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Collector"><a href="#module-Collector" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Collector/index.html">Collector</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-Provider_config"><a href="#module-Provider_config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Provider_config/index.html">Provider_config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Per-provider batching configuration.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Self_debug"><a href="#module-Self_debug" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Self_debug/index.html">Self_debug</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Emergency diagnostic logger for the OpenTelemetry SDK itself.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Dynamic_enricher"><a href="#module-Dynamic_enricher" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Dynamic_enricher/index.html">Dynamic_enricher</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Hooks to add attributes to every span or log</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Trace_provider"><a href="#module-Trace_provider" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace_provider/index.html">Trace_provider</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-Meter_provider"><a href="#module-Meter_provider" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Meter_provider/index.html">Meter_provider</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-Log_provider"><a href="#module-Log_provider" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Log_provider/index.html">Log_provider</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h3 id="identifiers"><a href="#identifiers" class="anchor"></a>Identifiers</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Trace_id"><a href="#module-Trace_id" class="anchor"></a><code><span><span class="keyword">module</span> Trace_id</span><span> = <a href="../Opentelemetry_core/Trace_id/index.html">Opentelemetry_core.Trace_id</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-k_trace_id"><a href="#val-k_trace_id" class="anchor"></a><code><span><span class="keyword">val</span> k_trace_id : <span><a href="../Opentelemetry_core/Trace_id/index.html#type-t">Trace_id.t</a> <a href="../../hmap/Hmap/index.html#type-key">Hmap.key</a></span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Span_id"><a href="#module-Span_id" class="anchor"></a><code><span><span class="keyword">module</span> Span_id</span><span> = <a href="../Opentelemetry_core/Span_id/index.html">Opentelemetry_core.Span_id</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Span_ctx"><a href="#module-Span_ctx" class="anchor"></a><code><span><span class="keyword">module</span> Span_ctx</span><span> = <a href="../Opentelemetry_core/Span_ctx/index.html">Opentelemetry_core.Span_ctx</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-k_ambient"><a href="#val-k_ambient" class="anchor"></a><code><span><span class="keyword">val</span> k_ambient : <span><a href="../Opentelemetry_core/Span_ctx/index.html#type-t">Span_ctx.t</a> <a href="../../hmap/Hmap/index.html#type-key">Hmap.key</a></span></span></code></div></div><h3 id="attributes-and-conventions"><a href="#attributes-and-conventions" class="anchor"></a>Attributes and conventions</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Conventions"><a href="#module-Conventions" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Conventions/index.html">Conventions</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Semantic conventions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Value"><a href="#module-Value" class="anchor"></a><code><span><span class="keyword">module</span> Value</span><span> = <a href="../Opentelemetry_core/Value/index.html">Opentelemetry_core.Value</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Key_value"><a href="#module-Key_value" class="anchor"></a><code><span><span class="keyword">module</span> Key_value</span><span> = <a href="../Opentelemetry_core/Key_value/index.html">Opentelemetry_core.Key_value</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-value"><a href="#type-value" class="anchor"></a><code><span><span class="keyword">type</span> value</span><span> = <a href="../Opentelemetry_core/Value/index.html#type-t">Value.t</a></span></code></div><div class="spec-doc"><p>A value in a key/value attribute</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-key_value"><a href="#type-key_value" class="anchor"></a><code><span><span class="keyword">type</span> key_value</span><span> = <a href="../Opentelemetry_core/Key_value/index.html#type-t">Key_value.t</a></span></code></div></div><h3 id="global-settings"><a href="#global-settings" class="anchor"></a>Global settings</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Globals"><a href="#module-Globals" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Globals/index.html">Globals</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Process-wide metadata, environment variables, etc.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Version"><a href="#module-Version" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Version/index.html">Version</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h3 id="traces-and-spans"><a href="#traces-and-spans" class="anchor"></a>Traces and Spans</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Event"><a href="#module-Event" class="anchor"></a><code><span><span class="keyword">module</span> Event</span><span> = <a href="../Opentelemetry_core/Event/index.html">Opentelemetry_core.Event</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Span_link"><a href="#module-Span_link" class="anchor"></a><code><span><span class="keyword">module</span> Span_link</span><span> = <a href="../Opentelemetry_core/Span_link/index.html">Opentelemetry_core.Span_link</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Span_status"><a href="#module-Span_status" class="anchor"></a><code><span><span class="keyword">module</span> Span_status</span><span> = <a href="../Opentelemetry_core/Span_status/index.html">Opentelemetry_core.Span_status</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Span_kind"><a href="#module-Span_kind" class="anchor"></a><code><span><span class="keyword">module</span> Span_kind</span><span> = <a href="../Opentelemetry_core/Span_kind/index.html">Opentelemetry_core.Span_kind</a></span></code></div></div><h3 id="traces"><a href="#traces" class="anchor"></a>Traces</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Span"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> Span</span><span> = <a href="../Opentelemetry_core/Span/index.html">Opentelemetry_core.Span</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ambient_span"><a href="#module-Ambient_span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Ambient_span/index.html">Ambient_span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Storing the current span in ambient context.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Tracer"><a href="#module-Tracer" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Tracer/index.html">Tracer</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-Trace"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> Trace</span><span> = <a href="Tracer/index.html">Tracer</a></span></code></div></div><h3 id="metrics"><a href="#metrics" class="anchor"></a>Metrics</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Metrics"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> Metrics</span><span> = <a href="../Opentelemetry_core/Metrics/index.html">Opentelemetry_core.Metrics</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Instrument"><a href="#module-Instrument" class="anchor"></a><code><span><span class="keyword">module</span> Instrument</span><span> = <a href="../Opentelemetry_core/Instrument/index.html">Opentelemetry_core.Instrument</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Meter"><a href="#module-Meter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Meter/index.html">Meter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h3 id="logs"><a href="#logs" class="anchor"></a>Logs</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Log_record"><a href="#module-Log_record" class="anchor"></a><code><span><span class="keyword">module</span> Log_record</span><span> = <a href="../Opentelemetry_core/Log_record/index.html">Opentelemetry_core.Log_record</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Logger"><a href="#module-Logger" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Logger/index.html">Logger</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-Logs"><a href="#module-Logs" class="anchor"></a><code><span><span class="keyword">module</span> Logs</span><span> = <a href="Logger/index.html">Logger</a></span></code></div></div><h3 id="utils"><a href="#utils" class="anchor"></a>Utils</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Any_signal"><a href="#module-Any_signal" class="anchor"></a><code><span><span class="keyword">module</span> Any_signal</span><span> = <a href="../Opentelemetry_core/Any_signal/index.html">Opentelemetry_core.Any_signal</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Any_signal_l"><a href="#module-Any_signal_l" class="anchor"></a><code><span><span class="keyword">module</span> Any_signal_l</span><span> = <a href="../Opentelemetry_core/Any_signal_l/index.html">Opentelemetry_core.Any_signal_l</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Trace_context"><a href="#module-Trace_context" class="anchor"></a><code><span><span class="keyword">module</span> Trace_context</span><span> = <a href="../Opentelemetry_core/Trace_context/index.html">Opentelemetry_core.Trace_context</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Gc_metrics"><a href="#module-Gc_metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Gc_metrics/index.html">Gc_metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Export GC metrics periodically.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Aswitch"><a href="#module-Aswitch" class="anchor"></a><code><span><span class="keyword">module</span> Aswitch</span><span> = <a href="../Opentelemetry_util/Aswitch/index.html">Opentelemetry_util.Aswitch</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Alist"><a href="#module-Alist" class="anchor"></a><code><span><span class="keyword">module</span> Alist</span><span> = <a href="../Opentelemetry_util/Alist/index.html">Opentelemetry_util.Alist</a></span></code></div><div class="spec-doc"><p>Atomic list, for internal usage</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-GC_metrics"><a href="#module-GC_metrics" class="anchor"></a><code><span><span class="keyword">module</span> GC_metrics</span><span> = <a href="Gc_metrics/index.html">Gc_metrics</a></span></code></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink