Add a logging BreachHandler (#149)

What: - add a logging BreachHandler Why: - Sometimes you may only want to log things when a certain log level is breached. And when that level is breached, you also want all the log records upto that point References: 1. https://tersesystems.com/blog/2019/07/28/triggering-diagnostic-logging-on-exception/ 2. https://docs.python.org/3.6/library/logging.handlers.html#logging.handlers.MemoryHandler
komuw · Aug 24, 2019 · 3e8931c · 3e8931c
1 parent d18dd96
commit 3e8931c
Show file tree

Hide file tree

Showing 38 changed files with 373 additions and 80 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 most recent version is listed first.
 
 
+## **version:** v0.6.4
+- added a logging BreachHandler: https://github.com/komuw/naz/pull/149
+
+
 ## **version:** v0.6.3
 - added static analysis support using pytype: https://github.com/komuw/naz/pull/148
 

diff --git a/benchmarks/my_logger.py b/benchmarks/my_logger.py
@@ -35,7 +35,7 @@ def makelog(log_directory="/usr/src/nazLog", log_file="naz_log_file"):
 log_file = makelog()
 
 
-class MyLogAdapter(naz.logger.NazLoggingAdapter):
+class MyLogAdapter(naz.logger._NazLoggingAdapter):
     def process(self, msg, kwargs):
         timestamp = self.formatTime()
         if isinstance(msg, str):

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; naz v0.6.3 documentation</title>
+  <title>Overview: module code &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/client.html b/docs/_modules/naz/client.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.client &mdash; naz v0.6.3 documentation</title>
+  <title>naz.client &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/correlater.html b/docs/_modules/naz/correlater.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.correlater &mdash; naz v0.6.3 documentation</title>
+  <title>naz.correlater &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/hooks.html b/docs/_modules/naz/hooks.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.hooks &mdash; naz v0.6.3 documentation</title>
+  <title>naz.hooks &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/logger.html b/docs/_modules/naz/logger.html
diff --git a/docs/_modules/naz/nazcodec.html b/docs/_modules/naz/nazcodec.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.nazcodec &mdash; naz v0.6.3 documentation</title>
+  <title>naz.nazcodec &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/q.html b/docs/_modules/naz/q.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.q &mdash; naz v0.6.3 documentation</title>
+  <title>naz.q &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/ratelimiter.html b/docs/_modules/naz/ratelimiter.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.ratelimiter &mdash; naz v0.6.3 documentation</title>
+  <title>naz.ratelimiter &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/sequence.html b/docs/_modules/naz/sequence.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.sequence &mdash; naz v0.6.3 documentation</title>
+  <title>naz.sequence &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/state.html b/docs/_modules/naz/state.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.state &mdash; naz v0.6.3 documentation</title>
+  <title>naz.state &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_modules/naz/throttle.html b/docs/_modules/naz/throttle.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz.throttle &mdash; naz v0.6.3 documentation</title>
+  <title>naz.throttle &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -60,7 +60,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/_sources/logger.rst.txt b/docs/_sources/logger.rst.txt
@@ -2,6 +2,6 @@ logger
 ---------------
 
 .. automodule:: naz.logger
-    :members: BaseLogger, SimpleLogger
+    :members: BaseLogger, SimpleLogger, BreachHandler
     :show-inheritance:
 
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.6.3',
+    VERSION: 'v0.6.4',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/client.html b/docs/client.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Client &mdash; naz v0.6.3 documentation</title>
+  <title>Client &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/correlater.html b/docs/correlater.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>correlater &mdash; naz v0.6.3 documentation</title>
+  <title>correlater &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/example_demo.html b/docs/example_demo.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Example demo of using naz &mdash; naz v0.6.3 documentation</title>
+  <title>Example demo of using naz &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; naz v0.6.3 documentation</title>
+  <title>Index &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 
@@ -192,6 +192,8 @@ <h2 id="_">_</h2>
         <li><a href="correlater.html#naz.correlater.SimpleCorrelater.__init__">(naz.correlater.SimpleCorrelater method)</a>
 </li>
         <li><a href="hooks.html#naz.hooks.SimpleHook.__init__">(naz.hooks.SimpleHook method)</a>
+</li>
+        <li><a href="logger.html#naz.logger.BreachHandler.__init__">(naz.logger.BreachHandler method)</a>
 </li>
         <li><a href="logger.html#naz.logger.SimpleLogger.__init__">(naz.logger.SimpleLogger method)</a>
 </li>
@@ -246,6 +248,8 @@ <h2 id="B">B</h2>
         <li><a href="logger.html#naz.logger.SimpleLogger.bind">(naz.logger.SimpleLogger method)</a>
 </li>
       </ul></li>
+      <li><a href="logger.html#naz.logger.BreachHandler">BreachHandler (class in naz.logger)</a>
+</li>
   </ul></td>
 </tr></table>
 
@@ -308,20 +312,22 @@ <h2 id="D">D</h2>
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="logger.html#naz.logger.BreachHandler.emit">emit() (naz.logger.BreachHandler method)</a>
+</li>
       <li><a href="nazcodec.html#naz.nazcodec.BaseNazCodec.encode">encode() (naz.nazcodec.BaseNazCodec method)</a>
 
       <ul>
         <li><a href="nazcodec.html#naz.nazcodec.SimpleNazCodec.encode">(naz.nazcodec.SimpleNazCodec method)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="queue.html#naz.q.BaseOutboundQueue.enqueue">enqueue() (naz.q.BaseOutboundQueue method)</a>
 
       <ul>
         <li><a href="queue.html#naz.q.SimpleOutboundQueue.enqueue">(naz.q.SimpleOutboundQueue method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="client.html#naz.client.Client.enquire_link">enquire_link() (naz.client.Client method)</a>
 </li>
       <li><a href="client.html#naz.client.Client.enquire_link_resp">enquire_link_resp() (naz.client.Client method)</a>

diff --git a/docs/hooks.html b/docs/hooks.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>hooks &mdash; naz v0.6.3 documentation</title>
+  <title>hooks &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/index.html b/docs/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>naz - naz is an async SMPP client. &mdash; naz v0.6.3 documentation</title>
+  <title>naz - naz is an async SMPP client. &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>
 
 

diff --git a/docs/introduction.html b/docs/introduction.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Introduction to naz &mdash; naz v0.6.3 documentation</title>
+  <title>Introduction to naz &mdash; naz v0.6.4 documentation</title>
 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                v0.6.3
+                v0.6.4
               </div>