mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
11 lines
No EOL
5.2 KiB
HTML
11 lines
No EOL
5.2 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (opentelemetry-client-ocurl.Opentelemetry_client_ocurl.Config)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">opentelemetry-client-ocurl</a> » <a href="../index.html">Opentelemetry_client_ocurl</a> » Config</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl.Config</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = </span><span>{</span></code><table><tr id="type-t.debug" class="anchored"><td class="def record field"><a href="#type-t.debug" class="anchor"></a><code><span>debug : bool;</span></code></td></tr><tr id="type-t.url" class="anchored"><td class="def record field"><a href="#type-t.url" class="anchor"></a><code><span>url : string;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Url of the endpoint. Default is "http://localhost:4318", or "OTEL_EXPORTER_OTLP_ENDPOINT" if set.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_traces" class="anchored"><td class="def record field"><a href="#type-t.batch_traces" class="anchor"></a><code><span>batch_traces : <span>int option</span>;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Batch traces? If <code>Some i</code>, then this produces batches of (at most) <code>i</code> items. If <code>None</code>, there is no batching.</p><p>Note that traces and metrics are batched separately. Default <code>Some 400</code>.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_metrics" class="anchored"><td class="def record field"><a href="#type-t.batch_metrics" class="anchor"></a><code><span>batch_metrics : <span>int option</span>;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Batch metrics? If <code>Some i</code>, then this produces batches of (at most) <code>i</code> items. If <code>None</code>, there is no batching.</p><p>Note that traces and metrics are batched separately. Default <code>None</code>.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.batch_timeout_ms" class="anchored"><td class="def record field"><a href="#type-t.batch_timeout_ms" class="anchor"></a><code><span>batch_timeout_ms : int;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Number of milliseconds after which we will emit a batch, even incomplete. Note that the batch might take longer than that, because this is only checked when a new event occurs. Default 500.</p><span class="comment-delim">*)</span></td></tr><tr id="type-t.thread" class="anchored"><td class="def record field"><a href="#type-t.thread" class="anchor"></a><code><span>thread : bool;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Is there a background thread? Default <code>true</code></p><span class="comment-delim">*)</span></td></tr><tr id="type-t.ticker_thread" class="anchored"><td class="def record field"><a href="#type-t.ticker_thread" class="anchor"></a><code><span>ticker_thread : bool;</span></code></td><td class="def-doc"><span class="comment-delim">(*</span><p>Is there a ticker thread? Default <code>true</code>. This thread will regularly call <code>tick()</code> on the backend, to make sure it makes progress, and regularly send events to the collector. This option is ignored if <code>thread=false</code>.</p><span class="comment-delim">*)</span></td></tr></table><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-make" class="anchored"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||
<span>?debug:bool <span class="arrow">-></span></span>
|
||
<span>?url:string <span class="arrow">-></span></span>
|
||
<span>?batch_traces:<span>int option</span> <span class="arrow">-></span></span>
|
||
<span>?batch_metrics:<span>int option</span> <span class="arrow">-></span></span>
|
||
<span>?batch_timeout_ms:int <span class="arrow">-></span></span>
|
||
<span>?thread:bool <span class="arrow">-></span></span>
|
||
<span>?ticker_thread:bool <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make a configuration</p></div></div><div class="odoc-spec"><div class="spec value" id="val-pp" class="anchored"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div></div></body></html> |