mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-08 20:07:55 -04:00
8 lines
4.7 KiB
HTML
8 lines
4.7 KiB
HTML
<!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> 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>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a>)</span>
|
||
<a href="../../../opentelemetry/Opentelemetry_client/Config/index.html#type-make">Opentelemetry_client.Config.make</a></span></span></code></div><div class="spec-doc"><p>Make a configuration <a href="#type-t"><code>t</code></a>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Env"><a href="#module-Env" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Env/index.html">Env</a></span><span> : <a href="../../../opentelemetry/Opentelemetry_client/Config/module-type-ENV/index.html">Opentelemetry_client.Config.ENV</a></span></code></div></div></div></body></html>
|