Merge pull request #2 from logtail/th/include-extra-attributes-by-default

Release v0.1.2

Author: gyfis

logtail/__init__.py

@@ -5,6 +5,6 @@
 from .helpers import LogtailContext, DEFAULT_CONTEXT
 from .formatter import LogtailFormatter
 
-__version__ = '0.1.1'
+__version__ = '0.1.2'
 
 context = DEFAULT_CONTEXT

logtail/formatter.py

@@ -21,5 +21,5 @@ def format(self, record):
         # which `extra` may be used to substitute arguments (see
         # https://docs.python.org/2/library/logging.html#logging.debug ), we
         # augment the log frame with all of the entries in extra.
-        frame = create_frame(record, record.getMessage(), self.context, include_all_extra=True)
+        frame = create_frame(record, record.getMessage(), self.context, include_extra_attributes=True)
         return json.dumps(frame, default=self.json_default, cls=self.json_encoder)

logtail/frame.py

@@ -5,7 +5,7 @@
 from os import path
 import __main__
 
-def create_frame(record, message, context, include_all_extra=False):
+def create_frame(record, message, context, include_extra_attributes=False):
     r = record.__dict__
     frame = {}
     frame['dt'] = datetime.utcfromtimestamp(r['created']).isoformat()
@@ -32,14 +32,14 @@ def create_frame(record, message, context, include_all_extra=False):
     if context.exists():
         ctx.update(context.collapse())
 
-    events = _parse_custom_events(record, include_all_extra)
+    events = _parse_custom_events(record, include_extra_attributes)
     if events:
         frame.update(events)
 
     return frame
 
 
-def _parse_custom_events(record, include_all_extra):
+def _parse_custom_events(record, include_extra_attributes):
     default_keys = {
         'args', 'asctime', 'created', 'exc_info', 'exc_text', 'pathname',
         'funcName', 'levelname', 'levelno', 'lineno', 'module', 'msecs',
@@ -50,7 +50,7 @@ def _parse_custom_events(record, include_all_extra):
     for key, val in record.__dict__.items():
         if key in default_keys:
             continue
-        if not include_all_extra and not isinstance(val, dict):
+        if not include_extra_attributes and not isinstance(val, dict):
             continue
         events[key] = val
     return events

logtail/handler.py

@@ -14,6 +14,7 @@
 DEFAULT_FLUSH_INTERVAL = 1
 DEFAULT_RAISE_EXCEPTIONS = False
 DEFAULT_DROP_EXTRA_EVENTS = True
+DEFAULT_INCLUDE_EXTRA_ATTRIBUTES = True
 
 
 class LogtailHandler(logging.Handler):
@@ -24,6 +25,7 @@ def __init__(self,
                  flush_interval=DEFAULT_FLUSH_INTERVAL,
                  raise_exceptions=DEFAULT_RAISE_EXCEPTIONS,
                  drop_extra_events=DEFAULT_DROP_EXTRA_EVENTS,
+                 include_extra_attributes=DEFAULT_INCLUDE_EXTRA_ATTRIBUTES,
                  context=DEFAULT_CONTEXT,
                  level=logging.NOTSET):
         super(LogtailHandler, self).__init__(level=level)
@@ -33,6 +35,7 @@ def __init__(self,
         self.pipe = multiprocessing.JoinableQueue(maxsize=buffer_capacity)
         self.uploader = Uploader(self.source_token, self.host)
         self.drop_extra_events = drop_extra_events
+        self.include_extra_attributes = include_extra_attributes
         self.buffer_capacity = buffer_capacity
         self.flush_interval = flush_interval
         self.raise_exceptions = raise_exceptions
@@ -54,7 +57,7 @@ def emit(self, record):
             if self._is_main_process() and not self.flush_thread.is_alive():
                 self.flush_thread.start()
             message = self.format(record)
-            frame = create_frame(record, message, self.context)
+            frame = create_frame(record, message, self.context, include_extra_attributes=self.include_extra_attributes)
             try:
                 self.pipe.put(frame, block=(not self.drop_extra_events))
             except queue.Full:

logtail/uploader.py

@@ -8,11 +8,12 @@ class Uploader(object):
     def __init__(self, source_token, host):
         self.source_token = source_token
         self.host = host
+        self.session = requests.Session()
         self.headers = {
             'Authorization': 'Bearer %s' % source_token,
             'Content-Type': 'application/msgpack',
         }
 
     def __call__(self, frame):
         data = msgpack.packb(frame, use_bin_type=True)
-        return requests.post(self.host, data=data, headers=self.headers)
+        return self.session.post(self.host, data=data, headers=self.headers)

setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup
 
 
-VERSION = '0.1.1'
+VERSION = '0.1.2'
 ROOT_DIR = os.path.dirname(__file__)
 
 REQUIREMENTS = [

tests/test_frame.py

@@ -26,5 +26,5 @@ def test_create_frame_with_extra(self):
         self.assertIn('dict_key', frame)
         self.assertNotIn('non_dict_key', frame)
 
-        frame = create_frame(log_record, log_record.getMessage(), LogtailContext(), include_all_extra=True)
+        frame = create_frame(log_record, log_record.getMessage(), LogtailContext(), include_extra_attributes=True)
         self.assertIn('non_dict_key', frame)

tests/test_uploader.py

@@ -12,7 +12,7 @@ class TestUploader(unittest2.TestCase):
     source_token = 'dummy_source_token'
     frame = [1, 2, 3]
 
-    @mock.patch('logtail.uploader.requests.post')
+    @mock.patch('logtail.uploader.requests.Session.post')
     def test_call(self, post):
         def mock_post(endpoint, data=None, headers=None):
             # Check that the data is sent to ther correct endpoint