simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-08 03:47:59 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-opentelemetry/opentelemetry/Opentelemetry/index.html
c-cube 74efdad1c1 deploy: 5dd68095ed
2024-09-20 16:15:07 +00:00

2 lines
13 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 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> &#x00BB; Opentelemetry</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry</span></code></h1><p>Opentelemetry types and instrumentation</p></header><nav class="odoc-toc"><ul><li><a href="#wire-format">Wire format</a></li><li><a href="#timestamps">Timestamps</a></li><li><a href="#interface-to-data-collector">Interface to data 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="#scopes">Scopes</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 class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Lock"><a href="#module-Lock" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Lock/index.html">Lock</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Global lock.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Rand_bytes"><a href="#module-Rand_bytes" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Rand_bytes/index.html">Rand_bytes</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Generation of random identifiers.</p></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> <a href="AList/index.html">AList</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Atomic list, for internal usage</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="timestamps"><a href="#timestamps" class="anchor"></a>Timestamps</h3><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> <a href="Timestamp_ns/index.html">Timestamp_ns</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unix timestamp.</p></div></div><h3 id="interface-to-data-collector"><a href="#interface-to-data-collector" class="anchor"></a>Interface to data collector</h3><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 class="spec-doc"><p>Collector types</p></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> <a href="Trace_id/index.html">Trace_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Trace ID.</p></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="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 class="spec-doc"><p>Hmap key to carry around a <a href="Trace_id/index.html#type-t"><code>Trace_id.t</code></a>, to remember what the current trace is.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></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> <a href="Span_id/index.html">Span_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unique ID of a span.</p></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> <a href="Span_ctx/index.html">Span_ctx</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Span context. This bundles up a trace ID and parent ID.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-k_span_ctx"><a href="#val-k_span_ctx" class="anchor"></a><code><span><span class="keyword">val</span> k_span_ctx : <span><a href="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 class="spec-doc"><p>Hmap key to carry around a <a href="Span_ctx/index.html#type-t"><code>Span_ctx.t</code></a>, e.g. to remember what the current parent span is.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></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 type anchored" id="type-value"><a href="#type-value" class="anchor"></a><code><span><span class="keyword">type</span> value</span><span> = </span><span>[ </span></code><ol><li id="type-value.Int" class="def variant constructor anchored"><a href="#type-value.Int" class="anchor"></a><code><span>| </span><span>`Int <span class="keyword">of</span> int</span></code></li><li id="type-value.String" class="def variant constructor anchored"><a href="#type-value.String" class="anchor"></a><code><span>| </span><span>`String <span class="keyword">of</span> string</span></code></li><li id="type-value.Bool" class="def variant constructor anchored"><a href="#type-value.Bool" class="anchor"></a><code><span>| </span><span>`Bool <span class="keyword">of</span> bool</span></code></li><li id="type-value.Float" class="def variant constructor anchored"><a href="#type-value.Float" class="anchor"></a><code><span>| </span><span>`Float <span class="keyword">of</span> float</span></code></li><li id="type-value.None" class="def variant constructor anchored"><a href="#type-value.None" class="anchor"></a><code><span>| </span><span>`None</span></code></li></ol><code><span> ]</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> = string * <a href="#type-value">value</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><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> <a href="Event/index.html">Event</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Events.</p></div></div><h3 id="scopes"><a href="#scopes" class="anchor"></a>Scopes</h3><div class="odoc-spec"><div class="spec module anchored" id="module-Scope"><a href="#module-Scope" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Scope/index.html">Scope</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Scopes.</p></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_link"><a href="#module-Span_link" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span_link/index.html">Span_link</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Span Link</p></div></div><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> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Spans.</p></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> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Traces.</p></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> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Metrics.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Metrics_callbacks"><a href="#module-Metrics_callbacks" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics_callbacks/index.html">Metrics_callbacks</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A set of callbacks that produce metrics when called. The metrics are automatically called regularly.</p></div></div><h3 id="logs"><a href="#logs" class="anchor"></a>Logs</h3><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> <a href="Logs/index.html">Logs</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Logs.</p></div></div><h3 id="utils"><a href="#utils" class="anchor"></a>Utils</h3><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> <a href="Trace_context/index.html">Trace_context</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Implementation of the W3C Trace Context spec</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> <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.</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink