timbre/taoensso.timbre.frequencies.html

12 lines
3.6 KiB
HTML
Raw Normal View History

2013-06-01 19:42:03 +07:00
<!DOCTYPE html>
2013-10-03 21:50:53 +07:00
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.timbre.frequencies documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Timbre 2.6.2 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.timbre.html"><span>taoensso.timbre</span></a></li><li class="current"><a href="taoensso.timbre.frequencies.html"><span>taoensso.timbre.frequencies</span></a></li><li><a href="taoensso.timbre.profiling.html"><span>taoensso.timbre.profiling</span></a></li><li><a href="taoensso.timbre.utils.html"><span>taoensso.timbre.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.timbre.frequencies.html#var-*fdata*"><span>*fdata*</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-f"><span>f</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-format-fdata"><span>format-fdata</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-fspy"><span>fspy</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-log-frequencies"><span>log-frequencies</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-sampling-log-frequencies"><span>sampling-log-frequencies</span></a></li><li><a href="taoensso.timbre.frequencies.html#var-with-fdata"><span>with-fdata</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.timbre.frequencies documentation</h2><pre class="doc">DEPRECATED.
Frequency logger for Timbre. ALPHA quality.</pre><div class="public" id="var-*fdata*"><h3>*fdata*</h3><div class="usage"></div><pre class="doc">{::fname {form-value frequency}}
</pre></div><div class="public" id="var-f"><h3>f</h3><h4 class="macro">macro</h4><div class="usage"><code>(f name &amp; body)</code></div><pre class="doc"></pre></div><div class="public" id="var-format-fdata"><h3>format-fdata</h3><div class="usage"><code>(format-fdata stats)</code></div><pre class="doc"></pre></div><div class="public" id="var-fspy"><h3>fspy</h3><h4 class="macro">macro</h4><div class="usage"><code>(fspy name &amp; body)</code></div><pre class="doc">Frequency spy. When in the context of a *fdata* binding, records the frequency
2013-06-01 19:42:03 +07:00
of each enumerated result. Always returns the body's result.</pre></div><div class="public" id="var-log-frequencies"><h3>log-frequencies</h3><h4 class="macro">macro</h4><div class="usage"><code>(log-frequencies level name &amp; body)</code></div><pre class="doc">When logging is enabled, executes named body with frequency counting enabled.
Body forms wrapped in (fspy) will have their result frequencies logged. Always
returns body's result.
Note that logging appenders will receive both a formatted frequencies string
AND the raw frequency stats under a special :frequency-stats key (useful for
queryable db logging).</pre></div><div class="public" id="var-sampling-log-frequencies"><h3>sampling-log-frequencies</h3><h4 class="macro">macro</h4><div class="usage"><code>(sampling-log-frequencies level proportion name &amp; body)</code></div><pre class="doc">Like `log-frequencies`, but only enables frequency counting every
2013-10-03 21:50:53 +07:00
1/`proportion` calls. Always returns body's result.</pre></div><div class="public" id="var-with-fdata"><h3>with-fdata</h3><h4 class="macro">macro</h4><div class="usage"><code>(with-fdata level &amp; body)</code></div><pre class="doc"></pre></div></div></body></html>