You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IBase__ScubaLogging (infer.IBase__ScubaLogging)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">infer</a> » IBase__ScubaLogging</nav><h1>Module <code>IBase__ScubaLogging</code></h1></header><aside><p>Functionality for logging into "infer_events" Scuba table. The table is organized in form of key-value pairs. Two most important fields are "event" and "value". Other fields in the table correspond to things common for this particular run of Infer.</p></aside><dl><dt class="spec value" id="val-log_many"><a href="#val-log_many" class="anchor"></a><code><span class="keyword">val</span> log_many : <span><a href="../IBase/LogEntry/index.html#type-t">IBase.LogEntry.t</a> list</span> <span>-></span> unit</code></dt><dd><p>Log several events in one go. Useful when you do custom aggregations and have a place to log all aggregated results at once.</p></dd></dl><dl><dt class="spec value" id="val-log_count"><a href="#val-log_count" class="anchor"></a><code><span class="keyword">val</span> log_count : <span>label:string</span> <span>-></span> <span>value:int</span> <span>-></span> unit</code></dt><dd><p>Log anything that can be counted. Events will be prefixed with <code>"count."</code></p></dd></dl><dl><dt class="spec value" id="val-log_message"><a href="#val-log_message" class="anchor"></a><code><span class="keyword">val</span> log_message : <span>label:string</span> <span>-></span> <span>message:string</span> <span>-></span> unit</code></dt><dd><p>Log a <code>string</code>. Event is prefixed with <code>"msg."</code></p></dd></dl><dl><dt class="spec value" id="val-cost_log_message"><a href="#val-cost_log_message" class="anchor"></a><code><span class="keyword">val</span> cost_log_message : <span>label:string</span> <span>-></span> <span>message:string</span> <span>-></span> unit</code></dt><dd><p>Similar to <code>log_message</code>, but log only when <code>--cost-scuba-logging</code> option is given.</p></dd></dl><dl><dt class="spec value" id="val-execute_with_time_logging"><a href="#val-execute_with_time_logging" class="anchor"></a><code><span class="keyword">val</span> execute_with_time_logging : string <span>-></span> <span>(unit <span>-></span> <span class="type-var">'a</span>)</span> <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>A helper to log execution time of a particular function. Use this to measure a performance of a given function. Example:</p><pre><code class="ml">let f a b = <some code>
|
|
|
|
|
let f a b = ScubaLogging.execute_with_time_logging "f" (fun () -> f a b)</code></pre></dd></dl><dl><dt class="spec value" id="val-register_global_log_flushing_at_exit"><a href="#val-register_global_log_flushing_at_exit" class="anchor"></a><code><span class="keyword">val</span> register_global_log_flushing_at_exit : unit <span>-></span> unit</code></dt></dl></div></body></html>
|