simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-09 12:23:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 3065f29347

Browse source
This commit is contained in:
c-cube 2022-03-22 17:41:44 +00:00
parent ebb664d80f
commit 990f16305d
6 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
dev/index.html
View file

@ -11,6 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="atomic/index.html">atomic</a> <span class="version">0.1</span></li>
<li><a href="opentelemetry/index.html">opentelemetry</a></li>
<li><a href="opentelemetry-client-ocurl/index.html">opentelemetry-client-ocurl</a></li>
<li><a href="opentelemetry-lwt/index.html">opentelemetry-lwt</a></li>

10
dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/Config/index.html Normal file
View file

@ -0,0 +1,10 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry-client-ocurl</a> &#x00BB; <a href="../index.html">Opentelemetry_client_ocurl</a> &#x00BB; Config</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl.Config</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><table><tr id="type-t.debug" class="anchored"><td class="def record field"><a href="#type-t.debug" class="anchor"></a><code><span>debug : bool;</span></code></td></tr><tr id="type-t.url" class="anchored"><td class="def record field"><a href="#type-t.url" class="anchor"></a><code><span>url : string;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Url of the endpoint. Default is &quot;http://localhost:4318&quot;, or &quot;OTEL_EXPORTER_OTLP_ENDPOINT&quot; if set.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_traces" class="anchored"><td class="def record field"><a href="#type-t.batch_traces" class="anchor"></a><code><span>batch_traces : <span>int option</span>;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Batch traces? If <code>Some i</code>, then this produces batches of (at most) <code>i</code> items. If <code>None</code>, there is no batching.</p><p>Note that traces and metrics are batched separately. Default <code>Some 400</code>.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_metrics" class="anchored"><td class="def record field"><a href="#type-t.batch_metrics" class="anchor"></a><code><span>batch_metrics : <span>int option</span>;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Batch metrics? If <code>Some i</code>, then this produces batches of (at most) <code>i</code> items. If <code>None</code>, there is no batching.</p><p>Note that traces and metrics are batched separately. Default <code>None</code>.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_timeout_ms" class="anchored"><td class="def record field"><a href="#type-t.batch_timeout_ms" class="anchor"></a><code><span>batch_timeout_ms : int;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs. Default 500.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.thread" class="anchored"><td class="def record field"><a href="#type-t.thread" class="anchor"></a><code><span>thread : bool;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Is there a background thread? Default <code>true</code></p><span class="comment-delim">*)</span></td></tr></table><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-make" class="anchored"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
<span>?debug:bool <span class="arrow">&#45;&gt;</span></span>
<span>?url:string <span class="arrow">&#45;&gt;</span></span>
<span>?batch_traces:<span>int option</span> <span class="arrow">&#45;&gt;</span></span>
<span>?batch_metrics:<span>int option</span> <span class="arrow">&#45;&gt;</span></span>
<span>?batch_timeout_ms:int <span class="arrow">&#45;&gt;</span></span>
<span>?thread:bool <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make a configuration</p></div></div><div class="odoc-spec"><div class="spec value" id="val-pp" class="anchored"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

7
dev/opentelemetry-client-ocurl/Opentelemetry_client_ocurl/index.html
View file

@ -1,2 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry-client-ocurl</a> &#x00BB; Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-get_url" class="anchored"><a href="#val-get_url" class="anchor"></a><code><span><span class="keyword">val</span> get_url : <span>unit <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-set_url" class="anchored"><a href="#val-set_url" class="anchor"></a><code><span><span class="keyword">val</span> set_url : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Url of the endpoint. Default is &quot;http://localhost:4318&quot;, or &quot;OTEL_EXPORTER_OTLP_ENDPOINT&quot; if set.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_mutex" class="anchored"><a href="#val-set_mutex" class="anchor"></a><code><span><span class="keyword">val</span> set_mutex : <span>lock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> <span>unlock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-setup" class="anchored"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Setup endpoint. This modifies <a href="../../opentelemetry/Opentelemetry/Collector/index.html#type-backend"><code>Opentelemetry.Collector.backend</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_setup" class="anchored"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup : <span><span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry-client-ocurl</a> &#x00BB; Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-get_url" class="anchored"><a href="#val-get_url" class="anchor"></a><code><span><span class="keyword">val</span> get_url : <span>unit <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-set_url" class="anchored"><a href="#val-set_url" class="anchor"></a><code><span><span class="keyword">val</span> set_url : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Url of the endpoint. Default is &quot;http://localhost:4318&quot;, or &quot;OTEL_EXPORTER_OTLP_ENDPOINT&quot; if set.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_mutex" class="anchored"><a href="#val-set_mutex" class="anchor"></a><code><span><span class="keyword">val</span> set_mutex : <span>lock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> <span>unlock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Set a lock/unlock pair to protect the critical sections of <a href="../../opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html"><code>Opentelemetry.Collector.BACKEND</code></a></p></div></div><div class="odoc-spec"><div class="spec module" id="module-Config" class="anchored"><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><div class="odoc-spec"><div class="spec value" id="val-setup" class="anchored"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>?config:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?enable:bool <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Setup endpoint. This modifies <a href="../../opentelemetry/Opentelemetry/Collector/index.html#type-backend"><code>Opentelemetry.Collector.backend</code></a>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">enable</span> <p>actually setup the backend (default true). This can be used to enable/disable the setup depending on CLI arguments or environment.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">config</span> <p>configuration to use</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-with_setup" class="anchored"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup :
<span>?config:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?enable:bool <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span><span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>with_setup () f</code> is like <code>setup(); f()</code> but takes care of cleaning up after <code>f()</code> returns.</p></div></div></div></body></html>

4
dev/opentelemetry-lwt/Opentelemetry_lwt/Metrics/index.html
View file

@ -19,4 +19,6 @@
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">&#45;&gt;</span></span>
<span>?is_monotonic:bool <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit some metrics to the collector.</p></div></div></div></body></html>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div><div class="odoc-spec"><div class="spec value" id="val-make_resource_metrics" class="anchored"><a href="#val-make_resource_metrics" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_metrics :
<span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.resource_metrics</span></span></code></div><div class="spec-doc"><p>Aggregate metrics into a <code>Proto</code>.Metrics.resource_metrics</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit some metrics to the collector.</p></div></div></div></body></html>

2
dev/opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; BACKEND</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.BACKEND</span></code></h1><p>Collector client interface.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><a href="../../Proto/Trace_service/index.html#type-export_trace_service_request">Proto.Trace_service.export_trace_service_request</a> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><a href="../../Proto/Metrics_service/index.html#type-export_metrics_service_request">Proto.Metrics_service.export_metrics_service_request</a> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-cleanup" class="anchored"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; BACKEND</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.BACKEND</span></code></h1><p>Collector client interface.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><span><a href="../../Proto/Trace/index.html#type-resource_spans">Proto.Trace.resource_spans</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><span><a href="../../Proto/Metrics/index.html#type-resource_metrics">Proto.Metrics.resource_metrics</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-cleanup" class="anchored"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

4
dev/opentelemetry/Opentelemetry/Metrics/index.html
View file

@ -19,4 +19,6 @@
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">&#45;&gt;</span></span>
<span>?is_monotonic:bool <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Emit some metrics to the collector (sync).</p></div></div></div></body></html>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div><div class="odoc-spec"><div class="spec value" id="val-make_resource_metrics" class="anchored"><a href="#val-make_resource_metrics" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_metrics :
<span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.resource_metrics</span></span></code></div><div class="spec-doc"><p>Aggregate metrics into a <a href="../Proto/Metrics/index.html#type-resource_metrics"><code>Proto.Metrics.resource_metrics</code></a></p></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Emit some metrics to the collector (sync).</p></div></div></div></body></html>