mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-10 04:35:44 -04:00
5 lines
No EOL
4 KiB
HTML
5 lines
No EOL
4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_tef (trace-tef.Trace_tef)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">trace-tef</a> » Trace_tef</nav><header class="odoc-preamble"><h1>Module <code><span>Trace_tef</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-collector"><a href="#val-collector" class="anchor"></a><code><span><span class="keyword">val</span> collector :
|
||
<span>out:<span>[ <span>`File of string</span> <span>| `Stderr</span> <span>| `Stdout</span> ]</span> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="../../trace/Trace/index.html#type-collector">Trace.collector</a></span></code></div><div class="spec-doc"><p>Make a collector that writes into the given output. See <a href="#val-setup"><code>setup</code></a> for more details.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-output"><a href="#type-output" class="anchor"></a><code><span><span class="keyword">type</span> output</span><span> = </span><span>[ </span></code><ol><li id="type-output.Stdout" class="def constructor anchored"><a href="#type-output.Stdout" class="anchor"></a><code><span>| </span></code><code><span>`Stdout</span></code></li><li id="type-output.Stderr" class="def constructor anchored"><a href="#type-output.Stderr" class="anchor"></a><code><span>| </span></code><code><span>`Stderr</span></code></li><li id="type-output.File" class="def constructor anchored"><a href="#type-output.File" class="anchor"></a><code><span>| </span></code><code><span>`File <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Output for tracing.</p><ul><li><code>`Stdout</code> will enable tracing and print events on stdout</li><li><code>`Stderr</code> will enable tracing and print events on stderr</li><li><code>`File "foo"</code> will enable tracing and print events into file named "foo"</li></ul></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>?out:<span>[ <a href="#type-output">output</a> <span>| `Env</span> ]</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>setup ()</code> installs the collector depending on <code>out</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">out</span> <p>can take different values:</p><ul><li>regular <a href="#type-output"><code>output</code></a> value to specify where events go</li><li><code>`Env</code> will enable tracing if the environment variable "TRACE" is set.</li></ul><p>If it's set to anything but "1", the value is taken to be the file path into which to write. If it's set to "1", then the file is "trace.json".</p></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>?out:<span>[ <a href="#type-output">output</a> <span>| `Env</span> ]</span> <span class="arrow">-></span></span> <span><span>(<span>unit <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>Setup, and make sure to shutdown before exiting</p></div></div></div></body></html> |