Skip to content

Commit

Permalink
io.aviso/logging 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hlship committed May 18, 2021
1 parent 3c104a2 commit 2fa3555
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion logging/index.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Logging 0.3.2</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">Logging</span> <span class="project-version">0.3.2</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>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></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>logging</span></div></div></li><li class="depth-4 branch"><a href="io.aviso.logging.capture.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>capture</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.correlation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>correlation</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.mdc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mdc</span></div></a></li><li class="depth-4"><a href="io.aviso.logging.setup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>setup</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Logging</span> <span class="project-version">0.3.2</span></span></h1><h5 class="license">Released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Sofware License 2.0</a></h5><div class="doc"><p>Clojure logging with Logback and SLF4J plus request correlation across servers.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[io.aviso/logging "0.3.2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="io.aviso.logging.capture.html">io.aviso.logging.capture</a></h3><div class="doc"><div class="markdown"><p>Capture logged events for in-process debugging and testing.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.capture.html#var-clear-logged-events">clear-logged-events</a> </li><li> <a href="io.aviso.logging.capture.html#var-logged-events">logged-events</a> </li><li> <a href="io.aviso.logging.capture.html#var-logged-events-fixture">logged-events-fixture</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.correlation.html">io.aviso.logging.correlation</a></h3><div class="doc"><div class="markdown"><p>Defines a minimal namespace containing a dynamic Var used to propogate the correlation id into the logging layer.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.correlation.html#var-*correlation-id*">*correlation-id*</a> </li><li> <a href="io.aviso.logging.correlation.html#var-default-correlation-id-generator">default-correlation-id-generator</a> </li><li> <a href="io.aviso.logging.correlation.html#var-wrap-with-request-correlation">wrap-with-request-correlation</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.mdc.html">io.aviso.logging.mdc</a></h3><div class="doc"><div class="markdown"><p>Allows arbitrary keys and values to be added to the event MDC.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.mdc.html#var-*extra-mdc*">*extra-mdc*</a> </li><li> <a href="io.aviso.logging.mdc.html#var-set-mdc-default">set-mdc-default</a> </li><li> <a href="io.aviso.logging.mdc.html#var-to-string-keys">to-string-keys</a> </li><li> <a href="io.aviso.logging.mdc.html#var-with-mdc">with-mdc</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.setup.html">io.aviso.logging.setup</a></h3><div class="doc"><div class="markdown"><p>Enables pretty exception reporting in the REPL and/or console, and sets up pretty exception logging when using clojure.tools.logging. Also installs an default uncaught exception handler, and initializes logging correlation id.</p></div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div></div></body></html>
<html><head><meta charset="UTF-8" /><title>Logging 1.0</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">Logging</span> <span class="project-version">1.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>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></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>logging</span></div></div></li><li class="depth-4 branch"><a href="io.aviso.logging.capture.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>capture</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.correlation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>correlation</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.mdc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mdc</span></div></a></li><li class="depth-4"><a href="io.aviso.logging.setup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>setup</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Logging</span> <span class="project-version">1.0</span></span></h1><h5 class="license">Released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Sofware License 2.0</a></h5><div class="doc"><p>Clojure logging with Logback and SLF4J plus request correlation across servers.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[io.aviso/logging "1.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="io.aviso.logging.capture.html">io.aviso.logging.capture</a></h3><div class="doc"><div class="markdown"><p>Capture logged events for in-process debugging and testing.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.capture.html#var-clear-logged-events">clear-logged-events</a> </li><li> <a href="io.aviso.logging.capture.html#var-logged-events">logged-events</a> </li><li> <a href="io.aviso.logging.capture.html#var-logged-events-fixture">logged-events-fixture</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.correlation.html">io.aviso.logging.correlation</a></h3><div class="doc"><div class="markdown"><p>Defines a minimal namespace containing a dynamic Var used to propogate the correlation id into the logging layer.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.correlation.html#var-*correlation-id*">*correlation-id*</a> </li><li> <a href="io.aviso.logging.correlation.html#var-default-correlation-id-generator">default-correlation-id-generator</a> </li><li> <a href="io.aviso.logging.correlation.html#var-wrap-with-request-correlation">wrap-with-request-correlation</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.mdc.html">io.aviso.logging.mdc</a></h3><div class="doc"><div class="markdown"><p>Allows arbitrary keys and values to be added to the event MDC.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.logging.mdc.html#var-*extra-mdc*">*extra-mdc*</a> </li><li> <a href="io.aviso.logging.mdc.html#var-set-mdc-default">set-mdc-default</a> </li><li> <a href="io.aviso.logging.mdc.html#var-to-string-keys">to-string-keys</a> </li><li> <a href="io.aviso.logging.mdc.html#var-with-mdc">with-mdc</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.logging.setup.html">io.aviso.logging.setup</a></h3><div class="doc"><div class="markdown"><p>Enables pretty exception reporting in the REPL and/or console, and sets up pretty exception logging when using clojure.tools.logging. Also installs an default uncaught exception handler, and initializes logging correlation id.</p></div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div></div></body></html>
2 changes: 1 addition & 1 deletion logging/io.aviso.logging.capture.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>io.aviso.logging.capture 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">Logging</span> <span class="project-version">0.3.2</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>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></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>logging</span></div></div></li><li class="depth-4 branch current"><a href="io.aviso.logging.capture.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>capture</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.correlation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>correlation</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.mdc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mdc</span></div></a></li><li class="depth-4"><a href="io.aviso.logging.setup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>setup</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="io.aviso.logging.capture.html#var-clear-logged-events"><div class="inner"><span>clear-logged-events</span></div></a></li><li class="depth-1"><a href="io.aviso.logging.capture.html#var-logged-events"><div class="inner"><span>logged-events</span></div></a></li><li class="depth-1"><a href="io.aviso.logging.capture.html#var-logged-events-fixture"><div class="inner"><span>logged-events-fixture</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">io.aviso.logging.capture</h1><h4 class="added">added in 0.3.0</h4><div class="doc"><div class="markdown"><p>Capture logged events for in-process debugging and testing.</p></div></div><div class="public anchor" id="var-clear-logged-events"><h3>clear-logged-events</h3><div class="usage"><code>(clear-logged-events)</code></div><div class="doc"><div class="markdown"><p>Clears any captured log events.</p></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/logging/blob/master/src/io/aviso/logging/capture.clj#L23">view source</a></div></div><div class="public anchor" id="var-logged-events"><h3>logged-events</h3><div class="usage"><code>(logged-events)</code></div><div class="doc"><div class="markdown"><p>Returns a snapshot, as a vector, of all events logged since the last clear of the log (the start of the current test).</p>
<html><head><meta charset="UTF-8" /><title>io.aviso.logging.capture 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">Logging</span> <span class="project-version">1.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>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></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>logging</span></div></div></li><li class="depth-4 branch current"><a href="io.aviso.logging.capture.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>capture</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.correlation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>correlation</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.logging.mdc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mdc</span></div></a></li><li class="depth-4"><a href="io.aviso.logging.setup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>setup</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="io.aviso.logging.capture.html#var-clear-logged-events"><div class="inner"><span>clear-logged-events</span></div></a></li><li class="depth-1"><a href="io.aviso.logging.capture.html#var-logged-events"><div class="inner"><span>logged-events</span></div></a></li><li class="depth-1"><a href="io.aviso.logging.capture.html#var-logged-events-fixture"><div class="inner"><span>logged-events-fixture</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">io.aviso.logging.capture</h1><h4 class="added">added in 0.3.0</h4><div class="doc"><div class="markdown"><p>Capture logged events for in-process debugging and testing.</p></div></div><div class="public anchor" id="var-clear-logged-events"><h3>clear-logged-events</h3><div class="usage"><code>(clear-logged-events)</code></div><div class="doc"><div class="markdown"><p>Clears any captured log events.</p></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/logging/blob/master/src/io/aviso/logging/capture.clj#L23">view source</a></div></div><div class="public anchor" id="var-logged-events"><h3>logged-events</h3><div class="usage"><code>(logged-events)</code></div><div class="doc"><div class="markdown"><p>Returns a snapshot, as a vector, of all events logged since the last clear of the log (the start of the current test).</p>
<p>Event maps have the following keys:</p>
<dl>
<dt>:level
Expand Down
Loading

0 comments on commit 2fa3555

Please sign in to comment.