mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
deploy: 62085e87cb
This commit is contained in:
parent
ba41df1096
commit
cff85694e4
7 changed files with 26 additions and 2 deletions
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Client (opentelemetry.Opentelemetry_client.Client)</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> » Client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Client</span></code></h1><p>Utilities for writing clients</p><p>These are used for implementing e.g., the <code>opentelemetry-client-cohttp-lwt</code> and <code>opentelemetry-client-ocurl</code> packages package.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> Config</span><span> = <a href="../Config/index.html">Config</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Client (opentelemetry.Opentelemetry_client.Client)</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> » Client</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Client</span></code></h1><p>Utilities for writing clients</p><p>These are used for implementing e.g., the <code>opentelemetry-client-cohttp-lwt</code> and <code>opentelemetry-client-ocurl</code> packages package.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> Config</span><span> = <a href="../Config/index.html">Config</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Signal"><a href="#module-Signal" class="anchor"></a><code><span><span class="keyword">module</span> Signal</span><span> = <a href="../Signal/index.html">Signal</a></span></code></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> Self_trace</span><span> = <a href="../Self_trace/index.html">Self_trace</a></span></code></div></div></div></body></html>
|
||||
|
|
|
|||
7
opentelemetry/Opentelemetry_client/Self_trace/index.html
Normal file
7
opentelemetry/Opentelemetry_client/Self_trace/index.html
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Self_trace (opentelemetry.Opentelemetry_client.Self_trace)</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> » Self_trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client.Self_trace</span></code></h1><p>Mini tracing module (disabled if <code>config.self_trace=false</code>)</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-add_event"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="../../Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <span class="arrow">-></span></span> <span><a href="../../Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<span><span class="optlabel">?kind</span>:<a href="../../Opentelemetry/Span_kind/index.html#type-t">Opentelemetry.Span_kind.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?attrs</span>:<span><span>(string * <a href="../../Opentelemetry/index.html#type-value">Opentelemetry.value</a>)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="../../Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <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-set_enabled"><a href="#val-set_enabled" class="anchor"></a><code><span><span class="keyword">val</span> set_enabled : <span>bool <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Converter (opentelemetry.Opentelemetry_client.Signal.Converter)</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> » <a href="../index.html">Signal</a> » Converter</nav><header class="odoc-preamble"><h1>Module <code><span>Signal.Converter</span></code></h1><p>Convert signals to protobuf encoded strings, ready to be sent over the wire</p><p>NOTE: The converters share an underlying stateful encoder, so each domain or system thread should have its own <code>Converter</code> instance</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-logs"><a href="#val-logs" class="anchor"></a><code><span><span class="keyword">val</span> logs :
|
||||
<span><span class="optlabel">?encoder</span>:<a href="../../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.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> <span class="arrow">-></span></span>
|
||||
string</span></code></div><div class="spec-doc"><p><code>logs ls</code> is a protobuf encoded string of the logs <code>ls</code></p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">encoder</span> <p>provide an encoder state to reuse</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-metrics"><a href="#val-metrics" class="anchor"></a><code><span><span class="keyword">val</span> metrics :
|
||||
<span><span class="optlabel">?encoder</span>:<a href="../../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.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> <span class="arrow">-></span></span>
|
||||
string</span></code></div><div class="spec-doc"><p><code>metrics ms</code> is a protobuf encoded string of the metrics <code>ms</code></p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">encoder</span> <p>provide an encoder state to reuse</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-traces"><a href="#val-traces" class="anchor"></a><code><span><span class="keyword">val</span> traces :
|
||||
<span><span class="optlabel">?encoder</span>:<a href="../../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.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> <span class="arrow">-></span></span>
|
||||
string</span></code></div><div class="spec-doc"><p><code>metrics ts</code> is a protobuf encoded string of the traces <code>ts</code></p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">encoder</span> <p>provide an encoder state to reuse</p></li></ul></div></div></div></body></html>
|
||||
2
opentelemetry/Opentelemetry_client/Signal/index.html
Normal file
2
opentelemetry/Opentelemetry_client/Signal/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!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 module anchored" id="module-Converter"><a href="#module-Converter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Converter/index.html">Converter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Convert signals to protobuf encoded strings, ready to be sent over the wire</p></div></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client (opentelemetry.Opentelemetry_client)</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> » 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-Client"><a href="#module-Client" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Client/index.html">Client</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utilities for writing clients</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">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 needed in common by all clients</p></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client (opentelemetry.Opentelemetry_client)</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> » 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-Client"><a href="#module-Client" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Client/index.html">Client</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Utilities for writing clients</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">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 needed in common by all clients</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 (disabled if <code>config.self_trace=false</code>)</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Signal"><a href="#module-Signal" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Signal/index.html">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></p></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client__Self_trace (opentelemetry.Opentelemetry_client__Self_trace)</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> » Opentelemetry_client__Self_trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client__Self_trace</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
2
opentelemetry/Opentelemetry_client__Signal/index.html
Normal file
2
opentelemetry/Opentelemetry_client__Signal/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client__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> » Opentelemetry_client__Signal</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client__Signal</span></code></h1></header><div class="odoc-content"><p>This module is hidden.</p></div></body></html>
|
||||
Loading…
Add table
Reference in a new issue