mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-08 03:47:59 -04:00
deploy: 883d1bc4e5
This commit is contained in:
c-cube
parent
336f856853
commit
0bd51165b7
8 changed files with 8 additions and 8 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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><p>Configuration for the ocurl backend</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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.bg_threads" class="def record field anchored"><a href="#type-t.bg_threads" class="anchor"></a><code><span>bg_threads : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Are there background threads, and how many? Default <code>4</code>. This will be adjusted to be at least <code>1</code> and at most <code>32</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.ticker_thread" class="def record field anchored"><a href="#type-t.ticker_thread" class="anchor"></a><code><span>ticker_thread : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>If true, start a thread that regularly checks if signals should be sent to the collector. Default <code>true</code></p><span class="comment-delim">*)</span></div></li><li id="type-t.ticker_interval_ms" class="def record field anchored"><a href="#type-t.ticker_interval_ms" class="anchor"></a><code><span>ticker_interval_ms : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Interval for ticker thread, in milliseconds. This is only useful if <code>ticker_thread</code> is <code>true</code>. This will be clamped between <code>2 ms</code> and some longer interval (maximum <code>60s</code> currently). Default 500.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul><span class="comment-delim">*)</span></div></li><li id="type-t.common" class="def record field anchored"><a href="#type-t.common" class="anchor"></a><code><span>common : <a href="../../../opentelemetry/Opentelemetry_client/Config/index.html#type-t">Opentelemetry_client.Config.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Common configuration options</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Configuration.</p><p>To build one, use <a href="#val-make"><code>make</code></a> below. This might be extended with more fields in the future.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <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 anchored" id="val-make"><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><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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><p>Configuration for the ocurl backend</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> t</span><span> = </span><span>{</span></code><ol><li id="type-t.bg_threads" class="def record field anchored"><a href="#type-t.bg_threads" class="anchor"></a><code><span>bg_threads : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Are there background threads, and how many? Default <code>4</code>. This will be adjusted to be at least <code>1</code> and at most <code>32</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-t.ticker_thread" class="def record field anchored"><a href="#type-t.ticker_thread" class="anchor"></a><code><span>ticker_thread : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>If true, start a thread that regularly checks if signals should be sent to the collector. Default <code>true</code></p><span class="comment-delim">*)</span></div></li><li id="type-t.ticker_interval_ms" class="def record field anchored"><a href="#type-t.ticker_interval_ms" class="anchor"></a><code><span>ticker_interval_ms : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Interval for ticker thread, in milliseconds. This is only useful if <code>ticker_thread</code> is <code>true</code>. This will be clamped between <code>2 ms</code> and some longer interval (maximum <code>60s</code> currently). Default 500.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul><span class="comment-delim">*)</span></div></li><li id="type-t.common" class="def record field anchored"><a href="#type-t.common" class="anchor"></a><code><span>common : <a href="../../../opentelemetry/Opentelemetry_client/Config/index.html#type-t">Opentelemetry_client.Config.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Common configuration options</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.12</li></ul><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Configuration.</p><p>To build one, use <a href="#val-make"><code>make</code></a> below. This might be extended with more fields in the future.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <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 anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||||
<span><span>(<span><span class="optlabel">?bg_threads</span>:int <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?ticker_thread</span>:bool <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?ticker_interval_ms</span>:int <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?enable</span>: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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">stop</span> <p>an atomic boolean. When it becomes true, background threads will all stop after a little while.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_backend"><a href="#val-remove_backend" class="anchor"></a><code><span><span class="keyword">val</span> remove_backend : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup :
|
||||
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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">stop</span> <p>an atomic boolean. When it becomes true, background threads will all stop after a little while.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_backend"><a href="#val-remove_backend" class="anchor"></a><code><span><span class="keyword">val</span> remove_backend : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.12</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_setup"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup :
|
||||
<span><span class="optlabel">?stop</span>:<span>bool <a href="../../opentelemetry/Opentelemetry_atomic/Atomic/index.html#type-t">Atomic.t</a></span> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?config</span>:<a href="Config/index.html#type-t">Config.t</a> <span class="arrow">-></span></span>
|
||||
<span><span class="optlabel">?enable</span>:bool <span class="arrow">-></span></span>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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="../../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>B (opentelemetry.Opentelemetry.Collector.Debug_backend.B)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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="../../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. </p><p>@since 0.12 </p></li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Noop_backend (opentelemetry.Opentelemetry.Collector.Noop_backend)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. </p><p>@since 0.12 </p></li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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 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="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. since NEXT_RELEASE</p></li></ul></div></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</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 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="../../../Opentelemetry_proto/Trace/index.html#type-resource_spans">Opentelemetry_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="../../../Opentelemetry_proto/Metrics/index.html#type-resource_metrics">Opentelemetry_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="../../../Opentelemetry_proto/Logs/index.html#type-resource_logs">Opentelemetry_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>unit <span class="arrow">-></span></span> unit)</span> <a href="../../AList/index.html#type-t">AList.t</a></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><span class="label">on_done</span>:<span>(<span>unit <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>cleanup ~on_done ()</code> is called when the collector is shut down, and is responsible for sending remaining batches, flushing sockets, etc.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">on_done</span> <p>callback invoked after the cleanup is done. </p><p>@since 0.12 </p></li></ul></div></div></div></body></html>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Globals (opentelemetry.Opentelemetry.Globals)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</a> » <a href="../../index.html">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Globals</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Globals</span></code></h1><p>Process-wide metadata, environment variables, etc.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-service_name"><a href="#val-service_name" class="anchor"></a><code><span><span class="keyword">val</span> service_name : <span>string <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Main service name metadata</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_namespace"><a href="#val-service_namespace" class="anchor"></a><code><span><span class="keyword">val</span> service_namespace : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Namespace for the service</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_instance_id"><a href="#val-service_instance_id" class="anchor"></a><code><span><span class="keyword">val</span> service_instance_id : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Unique identifier for the service</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_version"><a href="#val-service_version" class="anchor"></a><code><span><span class="keyword">val</span> service_version : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Version for the service</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> NEXT_RELEASE</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-instrumentation_library"><a href="#val-instrumentation_library" class="anchor"></a><code><span><span class="keyword">val</span> instrumentation_library : <a href="../../Opentelemetry_proto/Common/index.html#type-instrumentation_scope">Proto.Common.instrumentation_scope</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-global_attributes"><a href="#val-global_attributes" class="anchor"></a><code><span><span class="keyword">val</span> global_attributes : <span><span><a href="../../Opentelemetry_proto/Common/index.html#type-key_value">Proto.Common.key_value</a> list</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Global attributes, initially set via OTEL_RESOURCE_ATTRIBUTES and modifiable by the user code. They will be attached to each outgoing metrics/traces.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_global_attribute"><a href="#val-add_global_attribute" class="anchor"></a><code><span><span class="keyword">val</span> add_global_attribute : <span>string <span class="arrow">-></span></span> <span><a href="../index.html#type-value">value</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add a global attribute</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-merge_global_attributes_"><a href="#val-merge_global_attributes_" class="anchor"></a><code><span><span class="keyword">val</span> merge_global_attributes_ :
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Globals (opentelemetry.Opentelemetry.Globals)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.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">Index</a> » <a href="../../index.html">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Globals</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Globals</span></code></h1><p>Process-wide metadata, environment variables, etc.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-service_name"><a href="#val-service_name" class="anchor"></a><code><span><span class="keyword">val</span> service_name : <span>string <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Main service name metadata</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_namespace"><a href="#val-service_namespace" class="anchor"></a><code><span><span class="keyword">val</span> service_namespace : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Namespace for the service</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_instance_id"><a href="#val-service_instance_id" class="anchor"></a><code><span><span class="keyword">val</span> service_instance_id : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Unique identifier for the service</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-service_version"><a href="#val-service_version" class="anchor"></a><code><span><span class="keyword">val</span> service_version : <span><span>string option</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Version for the service</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.12</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-instrumentation_library"><a href="#val-instrumentation_library" class="anchor"></a><code><span><span class="keyword">val</span> instrumentation_library : <a href="../../Opentelemetry_proto/Common/index.html#type-instrumentation_scope">Proto.Common.instrumentation_scope</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-global_attributes"><a href="#val-global_attributes" class="anchor"></a><code><span><span class="keyword">val</span> global_attributes : <span><span><a href="../../Opentelemetry_proto/Common/index.html#type-key_value">Proto.Common.key_value</a> list</span> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Global attributes, initially set via OTEL_RESOURCE_ATTRIBUTES and modifiable by the user code. They will be attached to each outgoing metrics/traces.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_global_attribute"><a href="#val-add_global_attribute" class="anchor"></a><code><span><span class="keyword">val</span> add_global_attribute : <span>string <span class="arrow">-></span></span> <span><a href="../index.html#type-value">value</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Add a global attribute</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-merge_global_attributes_"><a href="#val-merge_global_attributes_" class="anchor"></a><code><span><span class="keyword">val</span> merge_global_attributes_ :
|
||||
<span><span><a href="../../Opentelemetry_proto/Common/index.html#type-key_value">Proto.Common.key_value</a> list</span> <span class="arrow">-></span></span>
|
||||
<span><a href="../../Opentelemetry_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="../../Opentelemetry_proto/Trace/index.html#type-span_span_kind">Proto.Trace.span_span_kind</a> <a href="../../../ocaml/Stdlib/index.html#type-ref">ref</a></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><span class="optlabel">?service_name</span>:string <span class="arrow">-></span></span>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue