mirror of https://github.com/status-im/timbre.git
10 lines
18 KiB
HTML
10 lines
18 KiB
HTML
<!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>Timbre 4.7.0</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 current"><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"><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="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Timbre</span> <span class="project-version">4.7.0</span></span></h1><div class="doc"><p>Pure Clojure/Script logging library.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.taoensso/timbre "4.7.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="taoensso.timbre.html">taoensso.timbre</a></h3><div class="doc"><pre class="plaintext">Simple, flexible logging for Clojure/Script. No XML.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.html#var-*config*">*config*</a> </li><li> <a href="taoensso.timbre.html#var-*context*">*context*</a> </li><li> <a href="taoensso.timbre.html#var--elide.3F">-elide?</a> </li><li> <a href="taoensso.timbre.html#var--levels-map">-levels-map</a> </li><li> <a href="taoensso.timbre.html#var--levels-set">-levels-set</a> </li><li> <a href="taoensso.timbre.html#var--levels-vec">-levels-vec</a> </li><li> <a href="taoensso.timbre.html#var--log.21">-log!</a> </li><li> <a href="taoensso.timbre.html#var--log-and-rethrow-errors">-log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.html#var--log-errors">-log-errors</a> </li><li> <a href="taoensso.timbre.html#var--logged-future">-logged-future</a> </li><li> <a href="taoensso.timbre.html#var--spy">-spy</a> </li><li> <a href="taoensso.timbre.html#var-color-str">color-str</a> </li><li> <a href="taoensso.timbre.html#var-compile-ns-filter">compile-ns-filter</a> </li><li> <a href="taoensso.timbre.html#var-debug">debug</a> </li><li> <a href="taoensso.timbre.html#var-debugf">debugf</a> </li><li> <a href="taoensso.timbre.html#var-default-err">default-err</a> </li><li> <a href="taoensso.timbre.html#var-default-out">default-out</a> </li><li> <a href="taoensso.timbre.html#var-default-output-fn">default-output-fn</a> </li><li> <a href="taoensso.timbre.html#var-default-timestamp-opts">default-timestamp-opts</a> </li><li> <a href="taoensso.timbre.html#var-error">error</a> </li><li> <a href="taoensso.timbre.html#var-errorf">errorf</a> </li><li> <a href="taoensso.timbre.html#var-example-config">example-config</a> </li><li> <a href="taoensso.timbre.html#var-fatal">fatal</a> </li><li> <a href="taoensso.timbre.html#var-fatalf">fatalf</a> </li><li> <a href="taoensso.timbre.html#var-get-.3Fhostname">get-?hostname</a> </li><li> <a href="taoensso.timbre.html#var-get-.3Fhostname_">get-?hostname_</a> </li><li> <a href="taoensso.timbre.html#var-get-env">get-env</a> </li><li> <a href="taoensso.timbre.html#var-get-hostname">get-hostname</a> </li><li> <a href="taoensso.timbre.html#var-handle-uncaught-jvm-exceptions.21">handle-uncaught-jvm-exceptions!</a> </li><li> <a href="taoensso.timbre.html#var-info">info</a> </li><li> <a href="taoensso.timbre.html#var-infof">infof</a> </li><li> <a href="taoensso.timbre.html#var-level.3E.3D">level>=</a> </li><li> <a href="taoensso.timbre.html#var-log">log</a> </li><li> <a href="taoensso.timbre.html#var-log.21">log!</a> </li><li> <a href="taoensso.timbre.html#var-log*">log*</a> </li><li> <a href="taoensso.timbre.html#var-log-and-rethrow-errors">log-and-rethrow-errors</a> </li><li> <a href="taoensso.timbre.html#var-log-env">log-env</a> </li><li> <a href="taoensso.timbre.html#var-log-errors">log-errors</a> </li><li> <a href="taoensso.timbre.html#var-log.3F">log?</a> </li><li> <a href="taoensso.timbre.html#var-logf">logf</a> </li><li> <a href="taoensso.timbre.html#var-logf*">logf*</a> </li><li> <a href="taoensso.timbre.html#var-logged-future">logged-future</a> </li><li> <a href="taoensso.timbre.html#var-logging-enabled.3F">logging-enabled?</a> </li><li> <a href="taoensso.timbre.html#var-logp">logp</a> </li><li> <a href="taoensso.timbre.html#var-may-log.3F">may-log?</a> </li><li> <a href="taoensso.timbre.html#var-merge-config.21">merge-config!</a> </li><li> <a href="taoensso.timbre.html#var-ordered-levels">ordered-levels</a> </li><li> <a href="taoensso.timbre.html#var-println-appender">println-appender</a> </li><li> <a href="taoensso.timbre.html#var-refer-timbre">refer-timbre</a> </li><li> <a href="taoensso.timbre.html#var-report">report</a> </li><li> <a href="taoensso.timbre.html#var-reportf">reportf</a> </li><li> <a href="taoensso.timbre.html#var-set-config.21">set-config!</a> </li><li> <a href="taoensso.timbre.html#var-set-level.21">set-level!</a> </li><li> <a href="taoensso.timbre.html#var-sometimes">sometimes</a> </li><li> <a href="taoensso.timbre.html#var-spit-appender">spit-appender</a> </li><li> <a href="taoensso.timbre.html#var-spy">spy</a> </li><li> <a href="taoensso.timbre.html#var-stacktrace">stacktrace</a> </li><li> <a href="taoensso.timbre.html#var-str-println">str-println</a> </li><li> <a href="taoensso.timbre.html#var-swap-config.21">swap-config!</a> </li><li> <a href="taoensso.timbre.html#var-trace">trace</a> </li><li> <a href="taoensso.timbre.html#var-tracef">tracef</a> </li><li> <a href="taoensso.timbre.html#var-valid-level">valid-level</a> </li><li> <a href="taoensso.timbre.html#var-valid-level.3F">valid-level?</a> </li><li> <a href="taoensso.timbre.html#var-warn">warn</a> </li><li> <a href="taoensso.timbre.html#var-warnf">warnf</a> </li><li> <a href="taoensso.timbre.html#var-with-config">with-config</a> </li><li> <a href="taoensso.timbre.html#var-with-context">with-context</a> </li><li> <a href="taoensso.timbre.html#var-with-default-outs">with-default-outs</a> </li><li> <a href="taoensso.timbre.html#var-with-level">with-level</a> </li><li> <a href="taoensso.timbre.html#var-with-log-level">with-log-level</a> </li><li> <a href="taoensso.timbre.html#var-with-logging-config">with-logging-config</a> </li><li> <a href="taoensso.timbre.html#var-with-merged-config">with-merged-config</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.gelf.html">taoensso.timbre.appenders.3rd-party.gelf</a></h3><div class="doc"><pre class="plaintext">Appender that sends GELF messages to a centralized logging server
|
|
(e.g. Graylog). Requires <a href="https://github.com/Graylog2/gelfclient">https://github.com/Graylog2/gelfclient</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.gelf.html#var-gelf-appender">gelf-appender</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.gelf.html#var-make-gelf-transport">make-gelf-transport</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.gelf.html#var-timbre-to-gelf-level">timbre-to-gelf-level</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.irclj.html">taoensso.timbre.appenders.3rd-party.irclj</a></h3><div class="doc"><pre class="plaintext">IRC appender. Requires <a href="https://github.com/flatland/irclj">https://github.com/flatland/irclj</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.irclj.html#var-irclj-appender">irclj-appender</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.irclj.html#var-make-irc-appender">make-irc-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.postgresql.html">taoensso.timbre.appenders.3rd-party.postgresql</a></h3><div class="doc"><pre class="plaintext">JDBC PostgreSQL database appender.
|
|
Requires <a href="https://github.com/clojure/java.jdbc">https://github.com/clojure/java.jdbc</a>,
|
|
<a href="https://github.com/swaldman/c3p0">https://github.com/swaldman/c3p0</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-conn">conn</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-connect">connect</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-default-pool-spec">default-pool-spec</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-ensure-conn">ensure-conn</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-log-message">log-message</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-pgsql-appender">pgsql-appender</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.postgresql.html#var-pool">pool</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.rolling.html">taoensso.timbre.appenders.3rd-party.rolling</a></h3><div class="doc"><pre class="plaintext">Rolling file appender.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.rolling.html#var-make-rolling-appender">make-rolling-appender</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.rolling.html#var-rolling-appender">rolling-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.rotor.html">taoensso.timbre.appenders.3rd-party.rotor</a></h3><div class="doc"><pre class="plaintext">Rotating file appender.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.rotor.html#var-make-rotor-appender">make-rotor-appender</a> </li><li> <a href="taoensso.timbre.appenders.3rd-party.rotor.html#var-rotor-appender">rotor-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.3rd-party.slack.html">taoensso.timbre.appenders.3rd-party.slack</a></h3><div class="doc"><pre class="plaintext">Slack appender. Requires <a href="https://github.com/julienXX/clj-slack">https://github.com/julienXX/clj-slack</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.3rd-party.slack.html#var-slack-appender">slack-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.carmine.html">taoensso.timbre.appenders.carmine</a></h3><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="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.carmine.html#var-carmine-appender">carmine-appender</a> </li><li> <a href="taoensso.timbre.appenders.carmine.html#var-default-entry-fn">default-entry-fn</a> </li><li> <a href="taoensso.timbre.appenders.carmine.html#var-default-keyfn">default-keyfn</a> </li><li> <a href="taoensso.timbre.appenders.carmine.html#var-default-nentries-by-level">default-nentries-by-level</a> </li><li> <a href="taoensso.timbre.appenders.carmine.html#var-make-carmine-appender">make-carmine-appender</a> </li><li> <a href="taoensso.timbre.appenders.carmine.html#var-query-entries">query-entries</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.core.html">taoensso.timbre.appenders.core</a></h3><div class="doc"><pre class="plaintext">Core Timbre appenders without any special dependency requirements.
|
|
These can be aliased into the main Timbre ns for convenience.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.core.html#var-println-appender">println-appender</a> </li><li> <a href="taoensso.timbre.appenders.core.html#var-spit-appender">spit-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.example.html">taoensso.timbre.appenders.example</a></h3><div class="doc"><pre class="plaintext">You can copy this namespace if you'd like a starting template for
|
|
writing your own Timbre appender. PRs for new appenders welcome!</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.example.html#var-example-appender">example-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.appenders.postal.html">taoensso.timbre.appenders.postal</a></h3><div class="doc"><pre class="plaintext">Email (Postal) appender. Requires <a href="https://github.com/drewr/postal">https://github.com/drewr/postal</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.appenders.postal.html#var-make-postal-appender">make-postal-appender</a> </li><li> <a href="taoensso.timbre.appenders.postal.html#var-postal-appender">postal-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.profiling.html">taoensso.timbre.profiling</a></h3><div class="doc"><pre class="plaintext">DEPRECATED, further development work will be focused on
|
|
Tufte at <a href="https://github.com/ptaoussanis/tufte">https://github.com/ptaoussanis/tufte</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.profiling.html#var-*pdata*">*pdata*</a> </li><li> <a href="taoensso.timbre.profiling.html#var-capture-time.21">capture-time!</a> </li><li> <a href="taoensso.timbre.profiling.html#var-defnp">defnp</a> </li><li> <a href="taoensso.timbre.profiling.html#var-fn-sigs">fn-sigs</a> </li><li> <a href="taoensso.timbre.profiling.html#var-fnp">fnp</a> </li><li> <a href="taoensso.timbre.profiling.html#var-format-stats">format-stats</a> </li><li> <a href="taoensso.timbre.profiling.html#var-fq-keyword">fq-keyword</a> </li><li> <a href="taoensso.timbre.profiling.html#var-merge-times.3Estats.21">merge-times>stats!</a> </li><li> <a href="taoensso.timbre.profiling.html#var-p">p</a> </li><li> <a href="taoensso.timbre.profiling.html#var-p*">p*</a> </li><li> <a href="taoensso.timbre.profiling.html#var-profile">profile</a> </li><li> <a href="taoensso.timbre.profiling.html#var-pspy">pspy</a> </li><li> <a href="taoensso.timbre.profiling.html#var-pspy*">pspy*</a> </li><li> <a href="taoensso.timbre.profiling.html#var-sampling-profile">sampling-profile</a> </li><li> <a href="taoensso.timbre.profiling.html#var-with-pdata">with-pdata</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.timbre.tools.logging.html">taoensso.timbre.tools.logging</a></h3><div class="doc"><pre class="plaintext">`clojure.tools.logging.impl/Logger` implementation.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.timbre.tools.logging.html#var--.3ELogger">->Logger</a> </li><li> <a href="taoensso.timbre.tools.logging.html#var--.3ELoggerFactory">->LoggerFactory</a> </li><li> <a href="taoensso.timbre.tools.logging.html#var-use-timbre">use-timbre</a> </li></ul></div></div></div></body></html> |