mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-08 03:47:59 -04:00
deploy: d578de0ceb
This commit is contained in:
ELLIOTTCABLE
parent
ad954e5aee
commit
7899a5ca3f
16 changed files with 161 additions and 33 deletions
|
|
@ -1,5 +1,9 @@
|
|||
<!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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/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 anchored" id="val-get_url"><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 anchored" id="val-set_url"><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 anchored" id="val-get_headers"><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 anchored" id="val-set_headers"><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 module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html">Opentelemetry_atomic.Atomic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Configuration for the ocurl backend</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> 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.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/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 anchored" id="val-get_url"><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 anchored" id="val-set_url"><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 anchored" id="val-get_headers"><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 anchored" id="val-set_headers"><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 module anchored" id="module-Atomic"><a href="#module-Atomic" class="anchor"></a><code><span><span class="keyword">module</span> Atomic</span><span> = <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html">Opentelemetry_atomic.Atomic</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Config"><a href="#module-Config" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Config/index.html">Config</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Configuration for the ocurl backend</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_backend"><a href="#val-create_backend" class="anchor"></a><code><span><span class="keyword">val</span> create_backend :
|
||||
<span>?stop:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||||
<span>?config:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||
<span>unit <span class="arrow">-></span></span>
|
||||
<span>(<span class="keyword">module</span> <a href="../../opentelemetry/Opentelemetry/Collector/module-type-BACKEND/index.html">Opentelemetry.Collector.BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setup"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup :
|
||||
<span>?stop:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -99,7 +99,12 @@
|
|||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Make a log entry with format</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
unit</span></code></div><div class="spec-doc"><p>Emit logs.</p><p>This instructs the collector to send the logs to some backend at a later date. <b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div></details></div></div></body></html>
|
||||
|
|
@ -3,14 +3,24 @@
|
|||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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 anchored" id="val-int"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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 anchored" id="val-gauge"><a href="#val-gauge" class="anchor"></a><code><span><span class="keyword">val</span> gauge :
|
||||
|
|
@ -29,7 +39,12 @@
|
|||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
|
|
@ -47,12 +62,22 @@
|
|||
<a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_resource_metrics"><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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
unit</span></code></div><div class="spec-doc"><p>Emit some metrics to the collector (sync). This blocks until the backend has pushed the metrics into some internal queue, or discarded them.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div></details></div></div></body></html>
|
||||
|
|
@ -2,13 +2,23 @@
|
|||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry-lwt.Opentelemetry_lwt.Trace)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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> » Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Trace</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/Trace/index.html">Opentelemetry.Trace</a> <span class="keyword">end</span></span></code></summary><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p><div class="odoc-spec"><div class="spec type anchored" id="type-span"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-t">Opentelemetry.Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_resource_spans"><a href="#val-make_resource_spans" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_spans :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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="../../../opentelemetry/Opentelemetry/Proto/Trace/index.html#type-span">Opentelemetry.Proto.Trace.span</a> list</span> <span class="arrow">-></span></span>
|
||||
<a href="../../../opentelemetry/Opentelemetry/Proto/Trace/index.html#type-resource_spans">Opentelemetry.Proto.Trace.resource_spans</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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-span">span</a> list</span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Sync emitter.</p><p>This instructs the collector to forward the spans to some backend at a later point.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-scope"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = <a href="../../../opentelemetry/Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a></span><span> = </span><span>{</span></code><ol><li id="type-scope.trace_id" class="def record field anchored"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a>;</span></code></li><li id="type-scope.span_id" class="def record field anchored"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a>;</span></code></li><li id="type-scope.events" class="def record field anchored"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../../../opentelemetry/Opentelemetry/Event/index.html#type-t">Opentelemetry.Event.t</a> list</span>;</span></code></li><li id="type-scope.attrs" class="def record field anchored"><a href="#type-scope.attrs" class="anchor"></a><code><span><span class="keyword">mutable</span> attrs : <span><a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-key_value">Opentelemetry.Span.key_value</a> list</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.t</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_event"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event :
|
||||
|
|
@ -17,14 +27,27 @@
|
|||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_event</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_attrs"><a href="#val-add_attrs" class="anchor"></a><code><span><span class="keyword">val</span> add_attrs :
|
||||
<span><a href="../../../opentelemetry/Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <span class="arrow">-></span></span>
|
||||
<span><span>(<span>unit <span class="arrow">-></span></span> <span><a href="../../../opentelemetry/Opentelemetry/index.html#type-key_value">Opentelemetry.key_value</a> list</span>)</span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_attrs</li></ul></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_attrs</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_'"><a href="#val-with_'" class="anchor"></a><code><span><span class="keyword">val</span> with_' :
|
||||
<span>?force_new_trace_id:bool <span class="arrow">-></span></span>
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-key_value">Opentelemetry.Span.key_value</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>?kind:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-kind">Span.kind</a> <span class="arrow">-></span></span>
|
||||
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>?parent:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-id">Span.id</a> <span class="arrow">-></span></span>
|
||||
<span>?scope:<a href="#type-scope">scope</a> <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><span>(string * <a href="../../../opentelemetry/Opentelemetry/index.html#type-value">Opentelemetry.value</a>)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?kind:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-kind">Opentelemetry.Span.kind</a> <span class="arrow">-></span></span>
|
||||
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>?parent:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-id">Opentelemetry.Span.id</a> <span class="arrow">-></span></span>
|
||||
<span>?scope:<a href="../../../opentelemetry/Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <span class="arrow">-></span></span>
|
||||
<span>?links:<span><a href="../../../opentelemetry/Opentelemetry/Span_link/index.html#type-t">Opentelemetry.Span_link.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||||
<span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> * <span>(<span><span><span>(unit, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="arrow">-></span></span> unit)</span></span></code></div></div><p>Sync span guard.</p><p>Notably, this includes <em>implicit</em> scope-tracking: if called without a <code>~scope</code> argument (or <code>~parent</code>/<code>~trace_id</code>), it will check in the <code>Ambient_context</code> for a surrounding environment, and use that as the scope. Similarly, it uses <code>Scope</code>.with_ambient_scope to <em>set</em> a new scope in the ambient context, so that any logically-nested calls to <a href="#val-with_"><code>with_</code></a> will use this span as their parent.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">force_new_trace_id</span> <p>if true (default false), the span will not use a ambient scope, the <code>~scope</code> argument, nor <code>~trace_id</code>, but will instead always create fresh identifiers for this span</p></li></ul></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<span>?force_new_trace_id:bool <span class="arrow">-></span></span>
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><span>(string * <a href="../../../opentelemetry/Opentelemetry/index.html#type-value">Opentelemetry.value</a>)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?kind:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-kind">Opentelemetry.Span.kind</a> <span class="arrow">-></span></span>
|
||||
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>?parent:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-id">Opentelemetry.Span.id</a> <span class="arrow">-></span></span>
|
||||
<span>?scope:<a href="../../../opentelemetry/Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <span class="arrow">-></span></span>
|
||||
<span>?links:<span><a href="../../../opentelemetry/Opentelemetry/Span_link/index.html#type-t">Opentelemetry.Span_link.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="../../../opentelemetry/Opentelemetry/Scope/index.html#type-t">Opentelemetry.Scope.t</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span>)</span> <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)</title><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../odoc.support/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> » <a href="../index.html">Debug_backend</a> » B</nav><header class="odoc-preamble"><h1>Parameter <code><span>Debug_backend.B</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><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 anchored" id="val-send_metrics"><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 anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../../Proto/Logs/index.html#type-resource_logs">Proto.Logs.resource_logs</a> list</span> <a href="../../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><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 anchored" id="val-tick"><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 anchored" id="val-set_on_tick_callbacks"><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 anchored" id="val-cleanup"><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>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Debug_backend (opentelemetry.Opentelemetry.Collector.Debug_backend)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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> » Debug_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Collector.Debug_backend</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-B"><a href="#argument-1-B" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-B/index.html">B</a></span><span> : <a href="../module-type-BACKEND/index.html">BACKEND</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><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 anchored" id="val-send_metrics"><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 anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../Proto/Logs/index.html#type-resource_logs">Proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><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 anchored" id="val-tick"><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 anchored" id="val-set_on_tick_callbacks"><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 anchored" id="val-cleanup"><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>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/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> » Noop_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Collector.Noop_backend</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-send_trace"><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 anchored" id="val-send_metrics"><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 anchored" id="val-send_logs"><a href="#val-send_logs" class="anchor"></a><code><span><span class="keyword">val</span> send_logs : <span><span><a href="../../Proto/Logs/index.html#type-resource_logs">Proto.Logs.resource_logs</a> list</span> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signal_emit_gc_metrics"><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 anchored" id="val-tick"><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 anchored" id="val-set_on_tick_callbacks"><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 anchored" id="val-cleanup"><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>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -4,7 +4,12 @@
|
|||
<span><a href="../Proto/Common/index.html#type-key_value">Proto.Common.key_value</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_span_kind"><a href="#val-default_span_kind" class="anchor"></a><code><span><span class="keyword">val</span> default_span_kind : <span><a href="../Proto/Trace/index.html#type-span_span_kind">Proto.Trace.span_span_kind</a> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>Default span kind in <a href="../Span/index.html#val-create"><code>Span.create</code></a>. This will be used in all spans that do not specify <code>~kind</code> explicitly; it is set to "internal", following directions from the <code>.proto</code> file. It can be convenient to set "client" or "server" uniformly in here.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk_attributes"><a href="#val-mk_attributes" class="anchor"></a><code><span><span class="keyword">val</span> mk_attributes :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>unit <span class="arrow">-></span></span>
|
||||
<span><a href="../Proto/Common/index.html#type-key_value">Proto.Common.key_value</a> list</span></span></code></div></div></div></body></html>
|
||||
|
|
@ -35,7 +35,12 @@
|
|||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Make a log entry with format</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
unit</span></code></div><div class="spec-doc"><p>Emit logs.</p><p>This instructs the collector to send the logs to some backend at a later date. <b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div></div></body></html>
|
||||
|
|
@ -3,14 +3,24 @@
|
|||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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 anchored" id="val-int"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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 anchored" id="val-gauge"><a href="#val-gauge" class="anchor"></a><code><span><span class="keyword">val</span> gauge :
|
||||
|
|
@ -29,7 +39,12 @@
|
|||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
|
|
@ -47,12 +62,22 @@
|
|||
<a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_resource_metrics"><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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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 <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 anchored" id="val-emit"><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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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>
|
||||
unit</span></code></div><div class="spec-doc"><p>Emit some metrics to the collector (sync). This blocks until the backend has pushed the metrics into some internal queue, or discarded them.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Thread_local (opentelemetry.Opentelemetry.Thread_local)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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> » Thread_local</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Thread_local</span></code></h1><p>Thread/Domain local storage</p><p>This allows the creation of global state that is per-domain or per-thread.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Create new storage</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p>Get current value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_exn"><a href="#val-get_exn" class="anchor"></a><code><span><span class="keyword">val</span> get_exn : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-get"><code>get</code></a> but fails with an exception</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Not_found</span> <p>if no value was found</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><span><span class="type-var">_</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_or_create"><a href="#val-get_or_create" class="anchor"></a><code><span><span class="keyword">val</span> get_or_create : <span>create:<span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span>(<span><span><span class="type-var">'a</span> option</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span class="type-var">'b</span></span></code></div><div class="spec-doc"><p><code>with_ var x f</code> sets <code>var</code> to <code>x</code> for this thread, calls <code>f prev</code> where <code>prev</code> is the value currently in <code>var</code> (if any), and then restores the old value of <code>var</code> for this thread.</p></div></div></div></body></html>
|
||||
|
|
@ -2,16 +2,38 @@
|
|||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry.Opentelemetry.Trace)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace</span></code></h1><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-span"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../Span/index.html#type-t">Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_resource_spans"><a href="#val-make_resource_spans" class="anchor"></a><code><span><span class="keyword">val</span> make_resource_spans :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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="../Proto/Trace/index.html#type-span">Proto.Trace.span</a> list</span> <span class="arrow">-></span></span>
|
||||
<a href="../Proto/Trace/index.html#type-resource_spans">Proto.Trace.resource_spans</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit :
|
||||
<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>
|
||||
<span><span>(string
|
||||
* <span>[< <span>`Bool of bool</span>
|
||||
<span><span>| `Float</span> of float</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-span">span</a> list</span> <span class="arrow">-></span></span>
|
||||
unit</span></code></div><div class="spec-doc"><p>Sync emitter.</p><p>This instructs the collector to forward the spans to some backend at a later point.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-scope"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = <a href="../Scope/index.html#type-t">Scope.t</a></span><span> = </span><span>{</span></code><ol><li id="type-scope.trace_id" class="def record field anchored"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../Trace_id/index.html#type-t">Trace_id.t</a>;</span></code></li><li id="type-scope.span_id" class="def record field anchored"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../Span_id/index.html#type-t">Span_id.t</a>;</span></code></li><li id="type-scope.events" class="def record field anchored"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../Event/index.html#type-t">Event.t</a> list</span>;</span></code></li><li id="type-scope.attrs" class="def record field anchored"><a href="#type-scope.attrs" class="anchor"></a><code><span><span class="keyword">mutable</span> attrs : <span><a href="../Span/index.html#type-key_value">Span.key_value</a> list</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.t</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_event"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <a href="../Event/index.html#type-t">Event.t</a>)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_event</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_attrs"><a href="#val-add_attrs" class="anchor"></a><code><span><span class="keyword">val</span> add_attrs : <span><a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span><a href="../index.html#type-key_value">key_value</a> list</span>)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_attrs</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
unit</span></code></div><div class="spec-doc"><p>Sync emitter.</p><p>This instructs the collector to forward the spans to some backend at a later point.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-scope"><a href="#type-scope" class="anchor"></a><code><span><span class="keyword">type</span> scope</span><span> = <a href="../Scope/index.html#type-t">Scope.t</a></span><span> = </span><span>{</span></code><ol><li id="type-scope.trace_id" class="def record field anchored"><a href="#type-scope.trace_id" class="anchor"></a><code><span>trace_id : <a href="../Trace_id/index.html#type-t">Trace_id.t</a>;</span></code></li><li id="type-scope.span_id" class="def record field anchored"><a href="#type-scope.span_id" class="anchor"></a><code><span>span_id : <a href="../Span_id/index.html#type-t">Span_id.t</a>;</span></code></li><li id="type-scope.events" class="def record field anchored"><a href="#type-scope.events" class="anchor"></a><code><span><span class="keyword">mutable</span> events : <span><a href="../Event/index.html#type-t">Event.t</a> list</span>;</span></code></li><li id="type-scope.attrs" class="def record field anchored"><a href="#type-scope.attrs" class="anchor"></a><code><span><span class="keyword">mutable</span> attrs : <span><a href="../Span/index.html#type-key_value">Span.key_value</a> list</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.t</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_event"><a href="#val-add_event" class="anchor"></a><code><span><span class="keyword">val</span> add_event : <span><a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <a href="../Event/index.html#type-t">Event.t</a>)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_event</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_attrs"><a href="#val-add_attrs" class="anchor"></a><code><span><span class="keyword">val</span> add_attrs : <span><a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span> <span><span>(<span>unit <span class="arrow">-></span></span> <span><a href="../index.html#type-key_value">key_value</a> list</span>)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> use Scope.add_attrs</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_'"><a href="#val-with_'" class="anchor"></a><code><span><span class="keyword">val</span> with_' :
|
||||
<span>?force_new_trace_id:bool <span class="arrow">-></span></span>
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
<span>?attrs:<span><span>(string * <a href="../index.html#type-value">value</a>)</span> list</span> <span class="arrow">-></span></span>
|
||||
<span>?kind:<a href="../Span/index.html#type-kind">Span.kind</a> <span class="arrow">-></span></span>
|
||||
<span>?trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||||
<span>?parent:<a href="../Span/index.html#type-id">Span.id</a> <span class="arrow">-></span></span>
|
||||
<span>?scope:<a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span>
|
||||
<span>?links:<span><a href="../Span_link/index.html#type-t">Span_link.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="#type-scope">scope</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||||
<span>(<span>unit <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> * <span>(<span><span><span>(unit, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="arrow">-></span></span> unit)</span></span></code></div></div><p>Sync span guard.</p><p>Notably, this includes <em>implicit</em> scope-tracking: if called without a <code>~scope</code> argument (or <code>~parent</code>/<code>~trace_id</code>), it will check in the <code>Ambient_context</code> for a surrounding environment, and use that as the scope. Similarly, it uses <a href="../Scope/index.html#val-with_ambient_scope"><code>Scope.with_ambient_scope</code></a> to <em>set</em> a new scope in the ambient context, so that any logically-nested calls to <a href="#val-with_"><code>with_</code></a> will use this span as their parent.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">force_new_trace_id</span> <p>if true (default false), the span will not use a ambient scope, the <code>~scope</code> argument, nor <code>~trace_id</code>, but will instead always create fresh identifiers for this span</p></li></ul><div class="odoc-spec"><div class="spec value anchored" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
|
||||
<span>?force_new_trace_id:bool <span class="arrow">-></span></span>
|
||||
<span>?trace_state:string <span class="arrow">-></span></span>
|
||||
<span>?service_name:string <span class="arrow">-></span></span>
|
||||
|
|
@ -23,4 +45,4 @@
|
|||
<span>?links:<span><a href="../Span_link/index.html#type-t">Span_link.t</a> list</span> <span class="arrow">-></span></span>
|
||||
<span>string <span class="arrow">-></span></span>
|
||||
<span><span>(<span><a href="../Scope/index.html#type-t">Scope.t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span>
|
||||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Sync span guard.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">force_new_trace_id</span> <p>if true (default false), the span will not use a surrounding context, or <code>scope</code>, or <code>trace_id</code>, but will always create a fresh new trace ID.</p><p><b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></li></ul></div></div></div></body></html>
|
||||
<span class="type-var">'a</span></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