Clean up - remove redundancy and clean up code (#5)

jaygel179 · darinhoward · commit b86cbd2151ab · 2019-08-12T10:40:10.000-05:00
* Clean up - remove redundancy and explicitly use stackify for internal logging

* Add note when using stackify api python logging

* disable stackify logging by default

* update internal logging instructions

* asign internal logging to a variable
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ logger.warning('Something happened')
 ```python
 import logging
 import stackify
-logger = logging.getLogger()
+logger = logging.getLogger(__name__)
 stackify_handler = stackify.StackifyHandler(application="Python Application", environment="Production", api_key="***")
 logger.addHandler(stackify_handler)
 logger.warning('Something happened')
@@ -68,7 +68,9 @@ This library has an internal logger it uses for debugging and messaging.
 For example, if you want to enable debug messages:
 ```python
 import logging
-logging.getLogger('stackify').setLevel(logging.DEBUG)
+logger = logging.getLogger('stackify')
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.FileHandler('stackify.log'))  # or any handler you want
 ```
 
 By default, it will enable the default logging settings via `logging.basicConfig()`
diff --git a/stackify/__init__.py b/stackify/__init__.py
@@ -17,7 +17,10 @@ def emit(self, record):
         pass
 
 
-logging.getLogger(__name__).addHandler(NullHandler())
+internal_logger = logging.getLogger(__name__)
+internal_logger.addHandler(NullHandler())
+internal_logger.propagate = False
+internal_logger.setLevel(DEFAULT_LEVEL)
 
 
 def getLogger(name=None, auto_shutdown=True, basic_config=True, **kwargs):
@@ -52,8 +55,7 @@ def getLogger(name=None, auto_shutdown=True, basic_config=True, **kwargs):
 
     logger = logging.getLogger(name)
 
-    if not [isinstance(x, StackifyHandler) for x in logger.handlers]:
-        internal_logger = logging.getLogger(__name__)
+    if not any([isinstance(x, StackifyHandler) for x in logger.handlers]):
         internal_logger.debug('Creating handler for logger %s', name)
 
         if auto_shutdown:
@@ -66,8 +68,6 @@ def getLogger(name=None, auto_shutdown=True, basic_config=True, **kwargs):
         handler = StackifyHandler(ensure_at_exit=not auto_shutdown, **kwargs)
         logger.addHandler(handler)
 
-        handler.listener.start()
-
     return logger
 
 
@@ -77,7 +77,7 @@ def stopLogging(logger):
     Shut down the StackifyHandler on a given logger. This will block
     and wait for the queue to finish uploading.
     '''
-    internal_logger = logging.getLogger(__name__)
+
     internal_logger.debug('Shutting down all handlers')
     for handler in getHandlers(logger):
         handler.listener.stop()
diff --git a/stackify/application.py b/stackify/application.py
@@ -36,8 +36,8 @@ def arg_or_env(name, args, default=None):
 
 
 def get_configuration(**kwargs):
-        return ApiConfiguration(
-            application=arg_or_env('application', kwargs),
-            environment=arg_or_env('environment', kwargs),
-            api_key=arg_or_env('api_key', kwargs),
-            api_url=arg_or_env('api_url', kwargs, API_URL))
+    return ApiConfiguration(
+        application=arg_or_env('application', kwargs),
+        environment=arg_or_env('environment', kwargs),
+        api_key=arg_or_env('api_key', kwargs),
+        api_url=arg_or_env('api_url', kwargs, API_URL))
diff --git a/stackify/handler.py b/stackify/handler.py
@@ -20,6 +20,9 @@
 from stackify.timer import RepeatedTimer
 
 
+internal_logger = logging.getLogger(__name__)
+
+
 class StackifyHandler(QueueHandler):
     '''
     A handler class to format and queue log messages for later
@@ -39,6 +42,7 @@ def __init__(self, queue_=None, listener=None, ensure_at_exit=True, **kwargs):
         self.listener.start()
 
         if ensure_at_exit:
+            internal_logger.debug('Registering atexit callback')
             atexit.register(self.listener.stop)
 
     def enqueue(self, record):
@@ -48,8 +52,7 @@ def enqueue(self, record):
         try:
             self.queue.put_nowait(record)
         except queue.Full:
-            logger = logging.getLogger(__name__)
-            logger.warning('StackifyHandler queue is full, evicting oldest record')
+            internal_logger.warning('StackifyHandler queue is full, evicting oldest record')
             self.queue.get_nowait()
             self.queue.put_nowait(record)
 
@@ -74,8 +77,7 @@ def __init__(self, queue_, max_batch=MAX_BATCH, config=None, **kwargs):
 
     def handle(self, record):
         if not self.http.identified:
-            logger = logging.getLogger(__name__)
-            logger.debug('Identifying application')
+            internal_logger.debug('Identifying application')
             self.http.identify_application()
 
         msg = LogMsg()
@@ -93,22 +95,19 @@ def send_group(self):
         try:
             self.http.send_log_group(group)
         except Exception:
-            logger = logging.getLogger(__name__)
-            logger.exception('Could not send {} log messages, discarding'.format(len(self.messages)))
+            internal_logger.exception('Could not send {} log messages, discarding'.format(len(self.messages)))
         del self.messages[:]
 
     def start(self):
-        logger = logging.getLogger(__name__)
-        logger.debug('Starting up listener')
+        internal_logger.debug('Starting up listener')
 
         if not self._started:
             super(StackifyListener, self).start()
             self.timer.start()
             self._started = True
 
     def stop(self):
-        logger = logging.getLogger(__name__)
-        logger.debug('Shutting down listener')
+        internal_logger.debug('Shutting down listener')
 
         if self._started:
             super(StackifyListener, self).stop()
@@ -117,5 +116,5 @@ def stop(self):
 
         # send any remaining messages
         if self.messages:
-            logger.debug('{} messages left on shutdown, uploading'.format(len(self.messages)))
+            internal_logger.debug('{} messages left on shutdown, uploading'.format(len(self.messages)))
             self.send_group()
diff --git a/stackify/http.py b/stackify/http.py
@@ -17,6 +17,9 @@
 from stackify.constants import READ_TIMEOUT
 
 
+internal_logger = logging.getLogger(__name__)
+
+
 def gzip_compress(data):
     if hasattr(gzip, 'compress'):
         return gzip.compress(bytes(data, 'utf-8'))  # python 3
@@ -41,8 +44,7 @@ def __init__(self, api_config):
 
     def POST(self, url, json_object, use_gzip=False):
         request_url = self.api_config.api_url + url
-        logger = logging.getLogger(__name__)
-        logger.debug('Request URL: {}'.format(request_url))
+        internal_logger.debug('Request URL: {}'.format(request_url))
 
         headers = {
             'Content-Type': 'application/json',
@@ -52,7 +54,7 @@ def POST(self, url, json_object, use_gzip=False):
 
         try:
             payload_data = json_object.toJSON()
-            logger.debug('POST data: {}'.format(payload_data))
+            internal_logger.debug('POST data: {}'.format(payload_data))
 
             if use_gzip:
                 headers['Content-Encoding'] = 'gzip'
@@ -62,13 +64,13 @@ def POST(self, url, json_object, use_gzip=False):
                                      data=payload_data,
                                      headers=headers,
                                      timeout=READ_TIMEOUT)
-            logger.debug('Response: {}'.format(response.text))
+            internal_logger.debug('Response: {}'.format(response.text))
             return response.json()
         except requests.exceptions.RequestException:
-            logger.exception('HTTP exception')
+            internal_logger.exception('HTTP exception')
         except ValueError:
             # could not read json response
-            logger.exception('Cannot decode JSON response')
+            internal_logger.exception('Cannot decode JSON response')
 
     @retrying.retry(wait_exponential_multiplier=1000, stop_max_delay=10000)
     def identify_application(self):
