telemere/taoensso.telemere.timbre.html

34 lines
14 KiB
HTML
Raw Normal View History

2024-04-10 16:41:24 +00:00
<!DOCTYPE html PUBLIC ""
"">
2024-09-23 07:20:57 +00:00
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.timbre documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-beta24</span></span></a></h1><div id="langs"><div class="lang current">clj</div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.open-telemetry.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>open-telemetry</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.postal.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>postal</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.slack.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>slack</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.sockets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sockets</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.streams.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>streams</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.telemere.timbre.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.tools-logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools-logging</span></div></a></li><li class="depth-3"><a href="taoensso.telemere.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-debug"><div class="inner"><span>debug</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-debugf"><div class="inner"><span>debugf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-error"><div class="inner"><span>error</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-errorf"><div class="inner"><span>errorf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-fatal"><div class="inner"><span>fatal</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-fatalf"><div class="inner"><span>fatalf</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-info"><div class="inner"><span>info</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-infof"><div class="inner"><span>infof</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.timbre.html#var-log"><di
2024-04-10 16:41:24 +00:00
Intended to help ease migration from Timbre to Telemere.</pre></div><div class="public anchor" id="var-debug"><h3>debug</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(debug &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-debugf"><h3>debugf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(debugf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-error"><h3>error</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(error &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-errorf"><h3>errorf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(errorf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-fatal"><h3>fatal</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(fatal &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-fatalf"><h3>fatalf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(fatalf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-info"><h3>info</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(info &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-infof"><h3>infof</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(infof &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-log"><h3>log</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log level &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-log-and-rethrow-errors"><h3>log-and-rethrow-errors</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log-and-rethrow-errors &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-log-errors"><h3>log-errors</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(log-errors &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-logf"><h3>logf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(logf level &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-logged-future"><h3>logged-future</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(logged-future &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/catch-&gt;error!`.
</pre></div></div><div class="public anchor" id="var-refer-timbre"><h3>refer-timbre</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(refer-timbre)</code></div><div class="doc"><pre class="plaintext">(require
'[taoensso.telemere.timbre :as timbre :refer
[log trace debug info warn error fatal report
logf tracef debugf infof warnf errorf fatalf reportf
spy]])</pre></div></div><div class="public anchor" id="var-report"><h3>report</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(report &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-reportf"><h3>reportf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(reportf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
2024-04-17 13:53:15 +00:00
</pre></div></div><div class="public anchor" id="var-set-min-level.21"><h3>set-min-level!</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.timbre.cljs.html#var-set-min-level.21">cljs</a></h4><div class="usage"><code>(set-min-level! min-level)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/set-min-level!`.
</pre></div></div><div class="public anchor" id="var-set-ns-min-level.21"><h3>set-ns-min-level!</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(set-ns-min-level! ?min-level)</code><code>(set-ns-min-level! ns ?min-level)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/set-min-level!`.
2024-05-23 08:10:16 +00:00
</pre></div></div><div class="public anchor" id="var-shutdown-appenders.21"><h3>shutdown-appenders!</h3><h4 class="lang current">clj</h4><h4 class="lang"><a href="taoensso.telemere.timbre.cljs.html#var-shutdown-appenders.21">cljs</a></h4><div class="usage"><code>(shutdown-appenders!)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/stop-handlers!`.
2024-04-10 16:41:24 +00:00
</pre></div></div><div class="public anchor" id="var-spy.21"><h3>spy!</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(spy! form)</code><code>(spy! level form)</code><code>(spy! level form-name form)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/spy!`.
</pre></div></div><div class="public anchor" id="var-trace"><h3>trace</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(trace &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-tracef"><h3>tracef</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(tracef &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-warn"><h3>warn</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(warn &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
</pre></div></div><div class="public anchor" id="var-warnf"><h3>warnf</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(warnf &amp; args)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/log!`, etc.
2024-04-17 13:53:15 +00:00
</pre></div></div><div class="public anchor" id="var-with-context"><h3>with-context</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(with-context context &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/with-ctx`.
</pre></div></div><div class="public anchor" id="var-with-context.2B"><h3>with-context+</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(with-context+ context &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/with-ctx+`.
</pre></div></div><div class="public anchor" id="var-with-min-level"><h3>with-min-level</h3><h4 class="type">macro</h4><h4 class="lang current">clj</h4><div class="usage"><code>(with-min-level min-level &amp; body)</code></div><div class="doc"><pre class="plaintext">Prefer `telemere/with-min-level`.
2024-04-10 16:41:24 +00:00
</pre></div></div></div></body></html>