mirror of
https://github.com/taoensso/telemere.git
synced 2025-12-17 01:51:10 +00:00
4 lines
No EOL
11 KiB
HTML
4 lines
No EOL
11 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>Telemere 1.0.0-RC2</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-RC2</span></span></a></h1><div id="langs"><div class="lang"><a href="index.clj.html">clj</a></div><div class="lang current">cljs</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.cljs.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.timbre.cljs.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"><a href="taoensso.telemere.utils.cljs.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="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-RC2</span></span></h1><h5 class="license">Released under the <a href="https://www.eclipse.org/legal/epl-v10.html">Eclipse Public License - v 1.0</a></h5><div class="doc"><p>Structured telemetry library for Clojure/Script.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[com.taoensso/telemere "1.0.0-RC2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="taoensso.telemere.cljs.html">taoensso.telemere</a></h3><div class="doc"><pre class="plaintext">Structured telemetry for Clojure/Script applications.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.telemere.cljs.html#var-*ctx*">*ctx*</a> </li><li> <a href="taoensso.telemere.cljs.html#var-*middleware*">*middleware*</a> </li><li> <a href="taoensso.telemere.cljs.html#var-*uid-fn*">*uid-fn*</a> </li><li> <a href="taoensso.telemere.cljs.html#var-add-handler.21">add-handler!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-catch-.3Eerror.21">catch->error!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-chance">chance</a> </li><li> <a href="taoensso.telemere.cljs.html#var-clean-signal-fn">clean-signal-fn</a> </li><li> <a href="taoensso.telemere.cljs.html#var-comp-middleware">comp-middleware</a> </li><li> <a href="taoensso.telemere.cljs.html#var-default-handler-dispatch-opts">default-handler-dispatch-opts</a> </li><li> <a href="taoensso.telemere.cljs.html#var-dispatch-signal.21">dispatch-signal!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-error.21">error!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-error-signal.3F">error-signal?</a> </li><li> <a href="taoensso.telemere.cljs.html#var-event.21">event!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-format-signal-fn">format-signal-fn</a> </li><li> <a href="taoensso.telemere.cljs.html#var-get-env">get-env</a> </li><li> <a href="taoensso.telemere.cljs.html#var-get-filters">get-filters</a> </li><li> <a href="taoensso.telemere.cljs.html#var-get-handlers">get-handlers</a> </li><li> <a href="taoensso.telemere.cljs.html#var-get-handlers-stats">get-handlers-stats</a> </li><li> <a href="taoensso.telemere.cljs.html#var-get-min-levels">get-min-levels</a> </li><li> <a href="taoensso.telemere.cljs.html#var-handler.3Aconsole">handler:console</a> </li><li> <a href="taoensso.telemere.cljs.html#var-handler.3Aconsole-raw">handler:console-raw</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Aenvironmental-config">help:environmental-config</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Afilters">help:filters</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Ahandler-dispatch-options">help:handler-dispatch-options</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Ahandlers">help:handlers</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Asignal-content">help:signal-content</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Asignal-creators">help:signal-creators</a> </li><li> <a href="taoensso.telemere.cljs.html#var-help.3Asignal-options">help:signal-options</a> </li><li> <a href="taoensso.telemere.cljs.html#var-level-aliases">level-aliases</a> </li><li> <a href="taoensso.telemere.cljs.html#var-log.21">log!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-msg-skip">msg-skip</a> </li><li> <a href="taoensso.telemere.cljs.html#var-msg-splice">msg-splice</a> </li><li> <a href="taoensso.telemere.cljs.html#var-newline">newline</a> </li><li> <a href="taoensso.telemere.cljs.html#var-pr-signal-fn">pr-signal-fn</a> </li><li> <a href="taoensso.telemere.cljs.html#var-rate-limiter">rate-limiter</a> </li><li> <a href="taoensso.telemere.cljs.html#var-remove-handler.21">remove-handler!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-ctx.21">set-ctx!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-id-filter.21">set-id-filter!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-kind-filter.21">set-kind-filter!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-middleware.21">set-middleware!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-min-level.21">set-min-level!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-ns-filter.21">set-ns-filter!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-set-var-root.21">set-var-root!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-signal.21">signal!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-signal-allowed.3F">signal-allowed?</a> </li><li> <a href="taoensso.telemere.cljs.html#var-spy.21">spy!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-stop-handlers.21">stop-handlers!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-trace.21">trace!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-uncaught-.3Eerror.21">uncaught->error!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-update-var-root.21">update-var-root!</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-ctx">with-ctx</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-ctx.2B">with-ctx+</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-err-.3Etelemere">with-err->telemere</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-handler">with-handler</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-handler.2B">with-handler+</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-id-filter">with-id-filter</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-kind-filter">with-kind-filter</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-middleware">with-middleware</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-middleware.2B">with-middleware+</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-min-level">with-min-level</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-ns-filter">with-ns-filter</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-out-.3Etelemere">with-out->telemere</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-signal">with-signal</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-signals">with-signals</a> </li><li> <a href="taoensso.telemere.cljs.html#var-with-streams-.3Etelemere">with-streams->telemere</a> </li><li> <a href="taoensso.telemere.cljs.html#var-without-filters">without-filters</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.telemere.timbre.cljs.html">taoensso.telemere.timbre</a></h3><div class="doc"><pre class="plaintext">Main Timbre macros, reimplemented on top of Telemere.
|
|
Intended to help ease migration from Timbre to Telemere.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.telemere.timbre.cljs.html#var-set-min-level.21">set-min-level!</a> </li><li> <a href="taoensso.telemere.timbre.cljs.html#var-shutdown-appenders.21">shutdown-appenders!</a> </li><li> <a href="taoensso.telemere.timbre.cljs.html#var-timbre-.3Etelemere-appender">timbre->telemere-appender</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.telemere.utils.cljs.html">taoensso.telemere.utils</a></h3><div class="doc"><pre class="plaintext">Misc utils useful for Telemere handlers, middleware, etc.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.telemere.utils.cljs.html#var-clean-signal-fn">clean-signal-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-error-signal.3F">error-signal?</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-error-fn">format-error-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-id">format-id</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-inst-fn">format-inst-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-level">format-level</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-location">format-location</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-nsecs-fn">format-nsecs-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-format-signal-fn">format-signal-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-hex-uid-fn">hex-uid-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-js-console-logger">js-console-logger</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-nano-uid-fn">nano-uid-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-newline">newline</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-pr-edn">pr-edn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-pr-json">pr-json</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-pr-signal-fn">pr-signal-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-signal-content-fn">signal-content-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-signal-preamble-fn">signal-preamble-fn</a> </li><li> <a href="taoensso.telemere.utils.cljs.html#var-uuid-str">uuid-str</a> </li></ul></div></div></div></body></html> |