mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
2 lines
5.6 KiB
HTML
2 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Signal (opentelemetry.Opentelemetry_client.Signal)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> » <a href="../../index.html">opentelemetry</a> » <a href="../index.html">Opentelemetry_client</a> » Signal</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Signal</span></code></h1><p>Constructing and managing OTel <a href="https://opentelemetry.io/docs/concepts/signals/">signals</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span></code><ol><li id="type-t.Traces" class="def variant constructor anchored"><a href="#type-t.Traces" class="anchor"></a><code><span>| </span><span><span class="constructor">Traces</span> <span class="keyword">of</span> <span><a href="../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span></span></code></li><li id="type-t.Metrics" class="def variant constructor anchored"><a href="#type-t.Metrics" class="anchor"></a><code><span>| </span><span><span class="constructor">Metrics</span> <span class="keyword">of</span> <span><a href="../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span></span></code></li><li id="type-t.Logs" class="def variant constructor anchored"><a href="#type-t.Logs" class="anchor"></a><code><span>| </span><span><span class="constructor">Logs</span> <span class="keyword">of</span> <span><a href="../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span></span></code></li></ol></div><div class="spec-doc"><p>The type of signals</p><p>This is not the principle type of signals from the perspective of what gets encoded and sent via protocl buffers, but it is the principle type that collector clients needs to reason about.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_traces"><a href="#val-to_traces" class="anchor"></a><code><span><span class="keyword">val</span> to_traces : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_proto.Trace.resource_spans</a> list</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_metrics"><a href="#val-to_metrics" class="anchor"></a><code><span><span class="keyword">val</span> to_metrics : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_proto.Metrics.resource_metrics</a> list</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_logs"><a href="#val-to_logs" class="anchor"></a><code><span><span class="keyword">val</span> to_logs : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_proto.Logs.resource_logs</a> list</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_traces"><a href="#val-is_traces" class="anchor"></a><code><span><span class="keyword">val</span> is_traces : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_metrics"><a href="#val-is_metrics" class="anchor"></a><code><span><span class="keyword">val</span> is_metrics : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_logs"><a href="#val-is_logs" class="anchor"></a><code><span><span class="keyword">val</span> is_logs : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Encode"><a href="#module-Encode" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Encode/index.html">Encode</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Encode signals to protobuf encoded strings, ready to be sent over the wire</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Decode"><a href="#module-Decode" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Decode/index.html">Decode</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Decode signals from protobuf encoded strings, received over the wire</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Pp"><a href="#module-Pp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Pp/index.html">Pp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
|