mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
38 lines
No EOL
7.5 KiB
HTML
38 lines
No EOL
7.5 KiB
HTML
<!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-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
|
||
<span>?start_time_unix_nano:int64 <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>float <span class="arrow">-></span></span>
|
||
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as a float</p></div></div><div class="odoc-spec"><div class="spec value" id="val-int" class="anchored"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int :
|
||
<span>?start_time_unix_nano:int64 <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>int <span class="arrow">-></span></span>
|
||
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as an int</p></div></div><div class="odoc-spec"><div class="spec value" id="val-gauge" class="anchored"><a href="#val-gauge" class="anchor"></a><code><span><span class="keyword">val</span> gauge :
|
||
<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><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>Aggregation of a scalar metric, always with the current value</p></div></div><div class="odoc-spec"><div class="spec type" id="type-aggregation_temporality" class="anchored"><a href="#type-aggregation_temporality" class="anchor"></a><code><span><span class="keyword">type</span> aggregation_temporality</span><span> = </span></code><table><tr id="type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_unspecified</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_delta" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_delta" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_delta</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_cumulative</span></span></code></td></tr></table></div></div><div class="odoc-spec"><div class="spec value" id="val-sum" class="anchored"><a href="#val-sum" class="anchor"></a><code><span><span class="keyword">val</span> sum :
|
||
<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:<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 :
|
||
<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><span><a href="#type-t">t</a> list</span> <span class="arrow">-></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>?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><span><a href="#type-t">t</a> list</span> <span class="arrow">-></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> |