timbre/taoensso.timbre.appenders.c...

<!DOCTYPE html PUBLIC ""
    "">
<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.appenders.carmine 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"><span class="project-title"><span class="project-name">Timbre</span> <span class="project-version">4.7.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><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.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"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>appenders</span></div></div></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>3rd-party</span></div></div></li><li class="depth-5 branch"><a href="taoensso.timbre.appenders.3rd-party.gelf.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gelf</span></div></a></li><li class="depth-5 branch"><a href="taoensso.timbre.appenders.3rd-party.irclj.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>irclj</span></div></a></li><li class="depth-5 branch"><a href="taoensso.timbre.appenders.3rd-party.postgresql.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>postgresql</span></div></a></li><li class="depth-5 branch"><a href="taoensso.timbre.appenders.3rd-party.rolling.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rolling</span></div></a></li><li class="depth-5 branch"><a href="taoensso.timbre.appenders.3rd-party.rotor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rotor</span></div></a></li><li class="depth-5"><a href="taoensso.timbre.appenders.3rd-party.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-4 branch current"><a href="taoensso.timbre.appenders.carmine.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>carmine</span></div></a></li><li class="depth-4 branch"><a href="taoensso.timbre.appenders.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-4 branch"><a href="taoensso.timbre.appenders.example.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>example</span></div></a></li><li class="depth-4"><a href="taoensso.timbre.appenders.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.timbre.profiling.html"><div class="inner"><span class="tree" style="top: -362px;"><span class="top" style="height: 371px;"></span><span class="bottom"></span></span><span>profiling</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></div></li><li class="depth-4"><a href="taoensso.timbre.tools.logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logging</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.timbre.appenders.carmine.html#var-carmine-appender"><div class="inner"><span>carmine-appender</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.carmine.html#var-default-entry-fn"><div class="inner"><span>default-entry-fn</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.carmine.html#var-default-keyfn"><div class="inner"><span>default-keyfn</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.carmine.html#var-default-nentries-by-level"><div class="inner"><span>default-nentries-by-level</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.carmine.html#var-make-carmine-appender"><div class="inner"><span>make-carmine-appender</span></div></a></li><li class="depth-1"><a href="taoensso.timbre.appenders.carmine.html#var-query-entries"><div class="inner"><span>query-entries</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.timbre.appenders.carmine</h1><div class="doc"><pre class="plaintext">Carmine (Redis) appender.
Requires <a href="https://github.com/ptaoussanis/carmine">https://github.com/ptaoussanis/carmine</a>.</pre></div><div class="public anchor" id="var-carmine-appender"><h3>carmine-appender</h3><div class="usage"><code>(carmine-appender &amp; [{:keys [conn-opts keyfn entry-fn nentries-by-level], :or {keyfn default-keyfn, entry-fn default-entry-fn, nentries-by-level default-nentries-by-level}}])</code></div><div class="doc"><pre class="plaintext">Alpha, subject to change.

Returns a Carmine Redis appender:
  * All raw logging args are preserved in serialized form (even errors).
  * Configurable number of entries to keep per logging level.
  * Only the most recent instance of each unique entry is kept.
  * Resulting log is just a Clojure value: a vector of log entries (maps).

See also `query-entries`.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L50">view source</a></div></div><div class="public anchor" id="var-default-entry-fn"><h3>default-entry-fn</h3><div class="usage"><code>(default-entry-fn data)</code></div><div class="doc"><pre class="plaintext">(fn [data])-&gt;&lt;db-entry&gt;
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L30">view source</a></div></div><div class="public anchor" id="var-default-keyfn"><h3>default-keyfn</h3><div class="usage"><code>(default-keyfn level)</code></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L20">view source</a></div></div><div class="public anchor" id="var-default-nentries-by-level"><h3>default-nentries-by-level</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L21">view source</a></div></div><div class="public anchor" id="var-make-carmine-appender"><h3>make-carmine-appender</h3><div class="usage"><code>(make-carmine-appender &amp; [appender-merge opts])</code></div><div class="doc"><pre class="plaintext">DEPRECATED. Please use `carmine-appender` instead.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L149">view source</a></div></div><div class="public anchor" id="var-query-entries"><h3>query-entries</h3><div class="usage"><code>(query-entries conn-opts level &amp; [n asc? keyfn])</code></div><div class="doc"><pre class="plaintext">Alpha, subject to change.
Returns latest `n` log entries by level as an ordered vector of
deserialized maps.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/carmine.clj#L112">view source</a></div></div></div></body></html>