mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
deploy: 60c6386742
This commit is contained in:
c-cube
parent
a6d7a660d4
commit
da014b0c38
10 changed files with 51 additions and 12 deletions
|
|
@ -1,7 +1,8 @@
|
|||
<!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> » <a href="../index.html">Opentelemetry_client_ocurl</a> » 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 "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" 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><tr id="type-t.ticker_thread" class="anchored"><td class="def record field"><a href="#type-t.ticker_thread" class="anchor"></a><code><span>ticker_thread : bool;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Is there a ticker thread? Default <code>true</code>. This thread will regularly call <code>tick()</code> on the backend, to make sure it makes progress, and regularly send events to the collector. This option is ignored if <code>thread=false</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 :
|
||||
<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> » <a href="../index.html">Opentelemetry_client_ocurl</a> » 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 "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.headers" class="anchored"><td class="def record field"><a href="#type-t.headers" class="anchor"></a><code><span>headers : <span><span>(string * string)</span> list</span>;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>API headers sent to the endpoint. Default is none or "OTEL_EXPORTER_OTLP_HEADERS" 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><tr id="type-t.ticker_thread" class="anchored"><td class="def record field"><a href="#type-t.ticker_thread" class="anchor"></a><code><span>ticker_thread : bool;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Is there a ticker thread? Default <code>true</code>. This thread will regularly call <code>tick()</code> on the backend, to make sure it makes progress, and regularly send events to the collector. This option is ignored if <code>thread=false</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">-></span></span>
|
||||
<span>?url:string <span class="arrow">-></span></span>
|
||||
<span>?headers:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?batch_traces:<span>int option</span> <span class="arrow">-></span></span>
|
||||
<span>?batch_metrics:<span>int option</span> <span class="arrow">-></span></span>
|
||||
<span>?batch_timeout_ms:int <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!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> » 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">-></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">-></span></span> unit</span></code></div><div class="spec-doc"><p>Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" 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">-></span></span> unit )</span> <span class="arrow">-></span></span> <span>unlock:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></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">-></span></span> <span>?enable:bool <span class="arrow">-></span></span> <span>unit <span class="arrow">-></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 :
|
||||
<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> » 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">-></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">-></span></span> unit</span></code></div><div class="spec-doc"><p>Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-get_headers" class="anchored"><a href="#val-get_headers" class="anchor"></a><code><span><span class="keyword">val</span> get_headers : <span>unit <span class="arrow">-></span></span> <span><span>(string * string)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-set_headers" class="anchored"><a href="#val-set_headers" class="anchor"></a><code><span><span class="keyword">val</span> set_headers : <span><span><span>(string * string)</span> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set http headers that are sent on every http query to the collector.</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">-></span></span> unit )</span> <span class="arrow">-></span></span> <span>unlock:<span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></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">-></span></span> <span>?enable:bool <span class="arrow">-></span></span> <span>unit <span class="arrow">-></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">-></span></span>
|
||||
<span>?enable:bool <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry-lwt.Opentelemetry_lwt.Metrics)</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-lwt</a> » <a href="../index.html">Opentelemetry_lwt</a> » Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Metrics</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Metrics/index.html">Opentelemetry.Metrics</a> <span class="keyword">end</span></span></code></summary><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p><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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-_program_start" class="anchored"><a href="#val-_program_start" class="anchor"></a><code><span><span class="keyword">val</span> _program_start : <a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry-lwt.Opentelemetry_lwt.Metrics)</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-lwt</a> » <a href="../index.html">Opentelemetry_lwt</a> » Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Metrics</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Metrics/index.html">Opentelemetry.Metrics</a> <span class="keyword">end</span></span></code></summary><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p><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></code></div><div class="spec-doc"><p>A single metric, measuring some time-varying quantity or statistical distribution. It is composed of one or more data points that have precise values and time stamps. Each distinct metric should have a distinct name.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
|
||||
<span>?start_time_unix_nano:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?now:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
|
|
@ -25,7 +25,25 @@
|
|||
<span>?aggregation_temporality:<a href="#type-aggregation_temporality">aggregation_temporality</a> <span class="arrow">-></span></span>
|
||||
<span>?is_monotonic:bool <span class="arrow">-></span></span>
|
||||
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">-></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-make_resource_metrics" class="anchored"><a href="#val-make_resource_metrics" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_metrics :
|
||||
<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-histogram_data_point" class="anchored"><a href="#val-histogram_data_point" class="anchor"></a><code><span><span class="keyword">val</span> histogram_data_point :
|
||||
<span>?start_time_unix_nano:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?now:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
<span><span>(string * <span>[< <span>`Bool of bool</span> <span><span>| `Int</span> of int</span> <span>| `None</span> <span><span>| `String</span> of string</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>?exemplars:<span><span class="xref-unresolved">Opentelemetry__Metrics_types.exemplar</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?explicit_bounds:<span>float list</span> <span class="arrow">-></span></span>
|
||||
<span>?sum:float <span class="arrow">-></span></span>
|
||||
<span>bucket_counts:<span>int64 list</span> <span class="arrow">-></span></span>
|
||||
<span>count:int64 <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span class="xref-unresolved">Opentelemetry__Metrics_types.histogram_data_point</span></span></code></div><div class="spec-doc"><p>Histogram data</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">count</span> <p>number of values in population (non negative)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">sum</span> <p>sum of values in population (0 if count is 0)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">bucket_counts</span> <p>count value of histogram for each bucket. Sum of the counts must be equal to <code>count</code>. length must be <code>1+length explicit_bounds</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">explicit_bounds</span> <p>strictly increasing list of bounds for the buckets</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-histogram" class="anchored"><a href="#val-histogram" class="anchor"></a><code><span><span class="keyword">val</span> histogram :
|
||||
<span>name:string <span class="arrow">-></span></span>
|
||||
<span>?description:string <span class="arrow">-></span></span>
|
||||
<span>?unit_:string <span class="arrow">-></span></span>
|
||||
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">-></span></span>
|
||||
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.histogram_data_point</span> list</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></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>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
<span><span>(string * <span>[< <span>`Bool of bool</span> <span><span>| `Int</span> of int</span> <span>| `None</span> <span><span>| `String</span> of string</span> ]</span>)</span>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</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> » <a href="../index.html">Opentelemetry</a> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-sender" class="anchored"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><table><tr id="type-sender.send" class="anchored"><td class="def record field"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <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></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>) but without <code>over</code> as it doesn't make much sense in presence of batching.</p><p>The <code>ret</code> callback is used to return the desired type (unit, or a Lwt promise, or anything else) once the event has been transferred to the backend. It doesn't mean the event has been collected yet, it could sit in a batch queue for a little while.</p></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-BACKEND" class="anchored"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-backend" class="anchored"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-backend" class="anchored"><a href="#val-backend" class="anchor"></a><code><span><span class="keyword">val</span> backend : <span><span><a href="#type-backend">backend</a> option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-has_backend" class="anchored"><a href="#val-has_backend" class="anchor"></a><code><span><span class="keyword">val</span> has_backend : <span>unit <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is there a configured backend?</p></div></div><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> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <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" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</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> » <a href="../index.html">Opentelemetry</a> » Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-sender" class="anchored"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><table><tr id="type-sender.send" class="anchored"><td class="def record field"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <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></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>) but without <code>over</code> as it doesn't make much sense in presence of batching.</p><p>The <code>ret</code> callback is used to return the desired type (unit, or a Lwt promise, or anything else) once the event has been transferred to the backend. It doesn't mean the event has been collected yet, it could sit in a batch queue for a little while.</p></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-BACKEND" class="anchored"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-backend" class="anchored"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-set_backend" class="anchored"><a href="#val-set_backend" class="anchor"></a><code><span><span class="keyword">val</span> set_backend : <span><a href="#type-backend">backend</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Set collector backend</p></div></div><div class="odoc-spec"><div class="spec value" id="val-has_backend" class="anchored"><a href="#val-has_backend" class="anchor"></a><code><span><span class="keyword">val</span> has_backend : <span>unit <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is there a configured backend?</p></div></div><div class="odoc-spec"><div class="spec value" id="val-get_backend" class="anchored"><a href="#val-get_backend" class="anchor"></a><code><span><span class="keyword">val</span> get_backend : <span>unit <span class="arrow">-></span></span> <span><a href="#type-backend">backend</a> option</span></span></code></div><div class="spec-doc"><p>Current backend, if any</p></div></div><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> <span class="arrow">-></span></span> <span>ret:<span>( <span>unit <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" 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> <span class="arrow">-></span></span>
|
||||
<span>ret:<span>( <span>unit <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" 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">-></span></span> bytes</span></code></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">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-tick" class="anchored"><a href="#val-tick" class="anchor"></a><code><span><span class="keyword">val</span> tick : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Do background work. Call this regularly if the collector doesn't already have a ticker thread or internal timer.</p></div></div></div></body></html>
|
||||
<span class="type-var">'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">-></span></span> bytes</span></code></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">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-on_tick" class="anchored"><a href="#val-on_tick" class="anchor"></a><code><span><span class="keyword">val</span> on_tick : <span><span>( <span>unit <span class="arrow">-></span></span> unit )</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-tick" class="anchored"><a href="#val-tick" class="anchor"></a><code><span><span class="keyword">val</span> tick : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Do background work. Call this regularly if the collector doesn't already have a ticker thread or internal timer.</p></div></div></div></body></html>
|
||||
|
|
@ -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> » <a href="../../index.html">Opentelemetry</a> » <a href="../index.html">Collector</a> » 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">-></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">-></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-signal_emit_gc_metrics" class="anchored"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-tick" class="anchored"><a href="#val-tick" class="anchor"></a><code><span><span class="keyword">val</span> tick : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</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">-></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> » <a href="../../index.html">Opentelemetry</a> » <a href="../index.html">Collector</a> » 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">-></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">-></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-signal_emit_gc_metrics" class="anchored"><a href="#val-signal_emit_gc_metrics" class="anchor"></a><code><span><span class="keyword">val</span> signal_emit_gc_metrics : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Signal the backend that it should emit GC metrics when it has the chance. This should be installed in a GC alarm or another form of regular trigger.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-tick" class="anchored"><a href="#val-tick" class="anchor"></a><code><span><span class="keyword">val</span> tick : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Should be called regularly for background processing, timeout checks, etc.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_on_tick_callbacks" class="anchored"><a href="#val-set_on_tick_callbacks" class="anchor"></a><code><span><span class="keyword">val</span> set_on_tick_callbacks : <span><span><span><span>( <span>unit <span class="arrow">-></span></span> unit )</span> list</span> <span class="xref-unresolved">Stdlib</span>.ref</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Give the collector the list of callbacks to be executed when <code>tick()</code> is called. Each such callback should be short and reentrant. Depending on the collector's implementation, it might be called from a thread that is not the one that called <code>on_tick</code>.</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">-></span></span> unit</span></code></div></div></div></body></html>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry.Opentelemetry.Metrics)</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> » <a href="../index.html">Opentelemetry</a> » Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Metrics</span></code></h1><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p></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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-_program_start" class="anchored"><a href="#val-_program_start" class="anchor"></a><code><span><span class="keyword">val</span> _program_start : <a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry.Opentelemetry.Metrics)</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> » <a href="../index.html">Opentelemetry</a> » Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Metrics</span></code></h1><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p></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></code></div><div class="spec-doc"><p>A single metric, measuring some time-varying quantity or statistical distribution. It is composed of one or more data points that have precise values and time stamps. Each distinct metric should have a distinct name.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
|
||||
<span>?start_time_unix_nano:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?now:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
|
|
@ -25,7 +25,25 @@
|
|||
<span>?aggregation_temporality:<a href="#type-aggregation_temporality">aggregation_temporality</a> <span class="arrow">-></span></span>
|
||||
<span>?is_monotonic:bool <span class="arrow">-></span></span>
|
||||
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">-></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-make_resource_metrics" class="anchored"><a href="#val-make_resource_metrics" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_metrics :
|
||||
<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-histogram_data_point" class="anchored"><a href="#val-histogram_data_point" class="anchor"></a><code><span><span class="keyword">val</span> histogram_data_point :
|
||||
<span>?start_time_unix_nano:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?now:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
<span><span>(string * <span>[< <span>`Bool of bool</span> <span><span>| `Int</span> of int</span> <span>| `None</span> <span><span>| `String</span> of string</span> ]</span>)</span>
|
||||
list</span> <span class="arrow">-></span></span>
|
||||
<span>?exemplars:<span><span class="xref-unresolved">Opentelemetry__Metrics_types.exemplar</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?explicit_bounds:<span>float list</span> <span class="arrow">-></span></span>
|
||||
<span>?sum:float <span class="arrow">-></span></span>
|
||||
<span>bucket_counts:<span>int64 list</span> <span class="arrow">-></span></span>
|
||||
<span>count:int64 <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span class="xref-unresolved">Opentelemetry__Metrics_types.histogram_data_point</span></span></code></div><div class="spec-doc"><p>Histogram data</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">count</span> <p>number of values in population (non negative)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">sum</span> <p>sum of values in population (0 if count is 0)</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">bucket_counts</span> <p>count value of histogram for each bucket. Sum of the counts must be equal to <code>count</code>. length must be <code>1+length explicit_bounds</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">explicit_bounds</span> <p>strictly increasing list of bounds for the buckets</p></li></ul></div></div><div class="odoc-spec"><div class="spec value" id="val-histogram" class="anchored"><a href="#val-histogram" class="anchor"></a><code><span><span class="keyword">val</span> histogram :
|
||||
<span>name:string <span class="arrow">-></span></span>
|
||||
<span>?description:string <span class="arrow">-></span></span>
|
||||
<span>?unit_:string <span class="arrow">-></span></span>
|
||||
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">-></span></span>
|
||||
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.histogram_data_point</span> list</span> <span class="arrow">-></span></span>
|
||||
<a href="#type-t">t</a></span></code></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>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:
|
||||
<span><span>(string * <span>[< <span>`Bool of bool</span> <span><span>| `Int</span> of int</span> <span>| `None</span> <span><span>| `String</span> of string</span> ]</span>)</span>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics_callbacks (opentelemetry.Opentelemetry.Metrics_callbacks)</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> » <a href="../index.html">Opentelemetry</a> » Metrics_callbacks</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Metrics_callbacks</span></code></h1><p>A set of callbacks that produce metrics when called.</p><p>The metrics are automatically called regularly.</p><p>This allows applications to register metrics callbacks from various points in the program (or even in libraries), and not worry about setting alarms/intervals to emit them.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-register" class="anchored"><a href="#val-register" class="anchor"></a><code><span><span class="keyword">val</span> register : <span><span>( <span>unit <span class="arrow">-></span></span> <span><a href="../Metrics/index.html#type-t">Metrics.t</a> list</span> )</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>register f</code> adds the callback <code>f</code> to the list. <code>f</code> will be called at unspecified times and is expected to return a list of metrics.</p></div></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span_id (opentelemetry.Opentelemetry.Span_id)</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> » <a href="../index.html">Opentelemetry</a> » Span_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span_id</span></code></h1><p>Unique ID of a span.</p></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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_hex" class="anchored"><a href="#val-to_hex" class="anchor"></a><code><span><span class="keyword">val</span> to_hex : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_hex" class="anchored"><a href="#val-of_hex" class="anchor"></a><code><span><span class="keyword">val</span> of_hex : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span_id (opentelemetry.Opentelemetry.Span_id)</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> » <a href="../index.html">Opentelemetry</a> » Span_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span_id</span></code></h1><p>Unique ID of a span.</p></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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_hex" class="anchored"><a href="#val-to_hex" class="anchor"></a><code><span><span class="keyword">val</span> to_hex : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_hex" class="anchored"><a href="#val-of_hex" class="anchor"></a><code><span><span class="keyword">val</span> of_hex : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_id (opentelemetry.Opentelemetry.Trace_id)</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> » <a href="../index.html">Opentelemetry</a> » Trace_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace_id</span></code></h1><p>Trace ID.</p><p>This 16 bytes identifier is shared by all spans in one trace.</p></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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_hex" class="anchored"><a href="#val-to_hex" class="anchor"></a><code><span><span class="keyword">val</span> to_hex : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_hex" class="anchored"><a href="#val-of_hex" class="anchor"></a><code><span><span class="keyword">val</span> of_hex : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_id (opentelemetry.Opentelemetry.Trace_id)</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> » <a href="../index.html">Opentelemetry</a> » Trace_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace_id</span></code></h1><p>Trace ID.</p><p>This 16 bytes identifier is shared by all spans in one trace.</p></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></code></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></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">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_hex" class="anchored"><a href="#val-to_hex" class="anchor"></a><code><span><span class="keyword">val</span> to_hex : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_hex" class="anchored"><a href="#val-of_hex" class="anchor"></a><code><span><span class="keyword">val</span> of_hex : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue