logtail-python 0.2.9__tar.gz → 0.3.0__tar.gz

{logtail-python-0.2.9/logtail_python.egg-info → logtail_python-0.3.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: logtail-python
-Version: 0.2.9
+Version: 0.3.0
 Summary: Logtail.com client library
 Home-page: https://github.com/logtail/logtail-python
-Download-URL: https://github.com/logtail/logtail-python/tarball/0.2.9
+Download-URL: https://github.com/logtail/logtail-python/tarball/0.3.0
 Author: Logtail
 Author-email: hello@logtail.com
 License: ISC
@@ -11,18 +11,18 @@ Keywords: api,logtail,logging,client
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: ISC License (ISCL)
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: requests>=2.18.4
+Requires-Dist: msgpack>=0.5.6
 
 # [Better Stack](https://betterstack.com/logs) Python client
 

{logtail-python-0.2.9 → logtail_python-0.3.0}/logtail/__init__.py

@@ -5,6 +5,6 @@ from .handler import LogtailHandler
 from .helpers import LogtailContext, DEFAULT_CONTEXT
 from .formatter import LogtailFormatter
 
-__version__ = '0.2.9'
+__version__ = '0.3.0'
 
 context = DEFAULT_CONTEXT

{logtail-python-0.2.9 → logtail_python-0.3.0}/logtail/flusher.py

@@ -10,14 +10,17 @@ RETRY_SCHEDULE = (1, 10, 60)  # seconds
 
 
 class FlushWorker(threading.Thread):
-    def __init__(self, upload, pipe, buffer_capacity, flush_interval):
+    def __init__(self, upload, pipe, buffer_capacity, flush_interval, check_interval):
         threading.Thread.__init__(self)
         self.parent_thread = threading.current_thread()
         self.upload = upload
         self.pipe = pipe
         self.buffer_capacity = buffer_capacity
         self.flush_interval = flush_interval
+        self.check_interval = check_interval
         self.should_run = True
+        self._flushing = False
+        self._clean = True
 
     def run(self):
         while self.should_run:
@@ -27,6 +30,7 @@ class FlushWorker(threading.Thread):
         last_flush = time.time()
         time_remaining = _initial_time_remaining(self.flush_interval)
         frame = []
+        self._clean = True
 
         # If the parent thread has exited but there are still outstanding
         # events, attempt to send them before exiting.
@@ -38,16 +42,17 @@ class FlushWorker(threading.Thread):
         # `flush_interval` seconds have passed without sending any events.
         while len(frame) < self.buffer_capacity and time_remaining > 0:
             try:
-                # Blocks for up to 1.0 seconds for each item to prevent
+                # Blocks for up to `check_interval` seconds for each item to prevent
                 # spinning and burning CPU unnecessarily. Could block for the
                 # entire amount of `time_remaining` but then in the case that
                 # the parent thread has exited, that entire amount of time
                 # would be waited before this child worker thread exits.
-                entry = self.pipe.get(block=(not shutdown), timeout=1.0)
+                entry = self.pipe.get(block=(not shutdown), timeout=self.check_interval)
+                self._clean = False
                 frame.append(entry)
                 self.pipe.task_done()
             except queue.Empty:
-                if shutdown:
+                if shutdown or self._flushing:
                     break
             shutdown = not self.parent_thread.is_alive()
             time_remaining = _calculate_time_remaining(last_flush, self.flush_interval)
@@ -68,9 +73,15 @@ class FlushWorker(threading.Thread):
             if response.status_code == 500 and getattr(response, "exception") != None:
                 print('Failed to send logs to Better Stack after {} retries: {}'.format(len(RETRY_SCHEDULE), response.exception))
 
+        self._clean = True
         if shutdown and self.pipe.empty():
             self.should_run = False
 
+    def flush(self):
+        self._flushing = True
+        while not self._clean or not self.pipe.empty():
+            time.sleep(self.check_interval)
+        self._flushing = False
 
 def _initial_time_remaining(flush_interval):
     return flush_interval

{logtail-python-0.2.9 → logtail_python-0.3.0}/logtail/frame.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 from __future__ import print_function, unicode_literals
-from datetime import datetime
+from datetime import datetime, timezone
 
 from os import path
 import __main__
@@ -11,10 +11,8 @@ def create_frame(record, message, context, include_extra_attributes=False):
     if "request" in r and not isinstance(r["request"], (dict, list, bool, int, float, str)) :
         del r["request"]
     frame = {}
-    # Python 3 only solution if we ever drop Python 2.7
-    # frame['dt'] = datetime.utcfromtimestamp(r['created']).replace(tzinfo=timezone.utc).isoformat()
-    frame['dt'] = "{}+00:00".format(datetime.utcfromtimestamp(r['created']).isoformat())
-    frame['level'] = level = _levelname(r['levelname'])
+    frame['dt'] = datetime.fromtimestamp(r['created'], timezone.utc).isoformat()
+    frame['level'] = _levelname(r['levelname'])
     frame['severity'] = int(r['levelno'] / 10)
     frame['message'] = message
     frame['context'] = ctx = {}
@@ -41,14 +39,13 @@ def create_frame(record, message, context, include_extra_attributes=False):
     if events:
         frame.update(events)
 
-    return frame
-
+    return _remove_circular_dependencies(frame)
 
 def _parse_custom_events(record, include_extra_attributes):
     default_keys = {
         'args', 'asctime', 'created', 'exc_info', 'exc_text', 'pathname',
         'funcName', 'levelname', 'levelno', 'lineno', 'module', 'msecs',
-        'message', 'msg', 'name', 'pathname', 'process', 'processName',
+        'message', 'msg', 'name', 'process', 'processName',
         'relativeCreated', 'thread', 'threadName'
     }
     events = {}
@@ -60,6 +57,22 @@ def _parse_custom_events(record, include_extra_attributes):
         events[key] = val
     return events
 
+def _remove_circular_dependencies(obj, memo=None):
+    if memo is None:
+        memo = set()
+    if id(obj) in memo:
+        return "<omitted circular reference>"
+    memo.add(id(obj))
+    if isinstance(obj, dict):
+        new_dict = {}
+        for key, value in obj.items():
+            new_dict[key] = _remove_circular_dependencies(value, memo)
+        return new_dict
+    elif isinstance(obj, list):
+        new_list = [_remove_circular_dependencies(item, memo) for item in obj]
+        return new_list
+    else:
+        return obj
 
 def _levelname(level):
     return level.lower()

{logtail-python-0.2.9 → logtail_python-0.3.0}/logtail/handler.py

@@ -12,6 +12,7 @@ from .frame import create_frame
 DEFAULT_HOST = 'https://in.logs.betterstack.com'
 DEFAULT_BUFFER_CAPACITY = 1000
 DEFAULT_FLUSH_INTERVAL = 1
+DEFAULT_CHECK_INTERVAL = 0.1
 DEFAULT_RAISE_EXCEPTIONS = False
 DEFAULT_DROP_EXTRA_EVENTS = True
 DEFAULT_INCLUDE_EXTRA_ATTRIBUTES = True
@@ -23,6 +24,7 @@ class LogtailHandler(logging.Handler):
                  host=DEFAULT_HOST,
                  buffer_capacity=DEFAULT_BUFFER_CAPACITY,
                  flush_interval=DEFAULT_FLUSH_INTERVAL,
+                 check_interval=DEFAULT_CHECK_INTERVAL,
                  raise_exceptions=DEFAULT_RAISE_EXCEPTIONS,
                  drop_extra_events=DEFAULT_DROP_EXTRA_EVENTS,
                  include_extra_attributes=DEFAULT_INCLUDE_EXTRA_ATTRIBUTES,
@@ -38,6 +40,7 @@ class LogtailHandler(logging.Handler):
         self.include_extra_attributes = include_extra_attributes
         self.buffer_capacity = buffer_capacity
         self.flush_interval = flush_interval
+        self.check_interval = check_interval
         self.raise_exceptions = raise_exceptions
         self.dropcount = 0
         # Do not initialize the flush thread yet because it causes issues on Render.
@@ -51,7 +54,8 @@ class LogtailHandler(logging.Handler):
             self.uploader,
             self.pipe,
             self.buffer_capacity,
-            self.flush_interval
+            self.flush_interval,
+            self.check_interval,
         )
         self.flush_thread.start()
 
@@ -68,7 +72,10 @@ class LogtailHandler(logging.Handler):
                 # Only raised when not blocking, which means that extra events
                 # should be dropped.
                 self.dropcount += 1
-                pass
         except Exception as e:
             if self.raise_exceptions:
                 raise e
+
+    def flush(self):
+        if self.flush_thread and self.flush_thread.is_alive():
+             self.flush_thread.flush()

{logtail-python-0.2.9 → logtail_python-0.3.0/logtail_python.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: logtail-python
-Version: 0.2.9
+Version: 0.3.0
 Summary: Logtail.com client library
 Home-page: https://github.com/logtail/logtail-python
-Download-URL: https://github.com/logtail/logtail-python/tarball/0.2.9
+Download-URL: https://github.com/logtail/logtail-python/tarball/0.3.0
 Author: Logtail
 Author-email: hello@logtail.com
 License: ISC
@@ -11,18 +11,18 @@ Keywords: api,logtail,logging,client
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: ISC License (ISCL)
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: requests>=2.18.4
+Requires-Dist: msgpack>=0.5.6
 
 # [Better Stack](https://betterstack.com/logs) Python client
 

{logtail-python-0.2.9 → logtail_python-0.3.0}/setup.py

@@ -3,7 +3,7 @@ import os
 from setuptools import setup
 
 
-VERSION = '0.2.9'
+VERSION = '0.3.0'
 ROOT_DIR = os.path.dirname(__file__)
 
 REQUIREMENTS = [
@@ -33,14 +33,12 @@ setup(
           'Intended Audience :: Developers',
           'License :: OSI Approved :: ISC License (ISCL)',
           'Operating System :: OS Independent',
-          'Programming Language :: Python :: 2',
-          'Programming Language :: Python :: 2.7',
           'Programming Language :: Python :: 3',
-          'Programming Language :: Python :: 3.5',
-          'Programming Language :: Python :: 3.6',
           'Programming Language :: Python :: 3.7',
           'Programming Language :: Python :: 3.8',
           'Programming Language :: Python :: 3.9',
+          'Programming Language :: Python :: 3.10',
+          'Programming Language :: Python :: 3.11',
           'Programming Language :: Python',
           'Topic :: Software Development :: Libraries :: Python Modules',
     ],

{logtail-python-0.2.9 → logtail_python-0.3.0}/tests/test_flusher.py

@@ -6,6 +6,8 @@ import time
 import threading
 import unittest
 
+from unittest.mock import patch
+
 from logtail.compat import queue
 from logtail.flusher import RETRY_SCHEDULE
 from logtail.flusher import FlushWorker
@@ -17,20 +19,20 @@ class TestFlushWorker(unittest.TestCase):
     source_token = 'dummy_source_token'
     buffer_capacity = 5
     flush_interval = 2
+    check_interval = 0.01
 
     def _setup_worker(self, uploader=None):
         pipe = queue.Queue(maxsize=self.buffer_capacity)
         uploader = uploader or Uploader(self.source_token, self.host)
-        fw = FlushWorker(uploader, pipe, self.buffer_capacity, self.flush_interval)
+        fw = FlushWorker(uploader, pipe, self.buffer_capacity, self.flush_interval, self.check_interval)
         return pipe, uploader, fw
 
     def test_is_thread(self):
-        pipe, uploader, fw = self._setup_worker()
+        _, _, fw = self._setup_worker()
         self.assertIsInstance(fw, threading.Thread)
 
     def test_flushes_when_queue_is_full(self):
         first_frame = list(range(self.buffer_capacity))
-        second_frame = list(range(self.buffer_capacity, self.buffer_capacity * 2))
         self.calls = 0
         self.flush_interval = 1000
 
@@ -51,7 +53,7 @@ class TestFlushWorker(unittest.TestCase):
 
         self.assertEqual(self.calls, 1)
 
-    @mock.patch('logtail.flusher._calculate_time_remaining')
+    @patch('logtail.flusher._calculate_time_remaining')
     def test_flushes_after_interval(self, calculate_time_remaining):
         self.buffer_capacity = 10
         num_items = 2
@@ -83,8 +85,8 @@ class TestFlushWorker(unittest.TestCase):
         self.assertEqual(self.upload_calls, 1)
         self.assertEqual(self.timeout_calls, 2)
 
-    @mock.patch('logtail.flusher._calculate_time_remaining')
-    @mock.patch('logtail.flusher._initial_time_remaining')
+    @patch('logtail.flusher._calculate_time_remaining')
+    @patch('logtail.flusher._initial_time_remaining')
     def test_does_nothing_without_any_items(self, initial_time_remaining, calculate_time_remaining):
         calculate_time_remaining.side_effect = lambda a,b: 0.0
         initial_time_remaining.side_effect = lambda a: 0.0001
@@ -96,7 +98,7 @@ class TestFlushWorker(unittest.TestCase):
         fw.step()
         self.assertFalse(uploader.called)
 
-    @mock.patch('logtail.flusher.time.sleep')
+    @patch('logtail.flusher.time.sleep')
     def test_retries_according_to_schedule(self, mock_sleep):
         first_frame = list(range(self.buffer_capacity))
 

{logtail-python-0.2.9 → logtail_python-0.3.0}/tests/test_handler.py

@@ -6,20 +6,22 @@ import threading
 import unittest
 import logging
 
-from logtail import LogtailHandler, context
+from unittest.mock import patch
 
+from logtail import LogtailHandler, context
+from logtail.handler import FlushWorker
 
 class TestLogtailHandler(unittest.TestCase):
     source_token = 'dummy_source_token'
     host = 'dummy_host'
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_handler_creates_uploader_from_args(self, MockWorker):
         handler = LogtailHandler(source_token=self.source_token, host=self.host)
         self.assertEqual(handler.uploader.source_token, self.source_token)
         self.assertEqual(handler.uploader.host, self.host)
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_handler_creates_pipe_from_args(self, MockWorker):
         buffer_capacity = 9
         flush_interval = 1
@@ -30,11 +32,12 @@ class TestLogtailHandler(unittest.TestCase):
         )
         self.assertTrue(handler.pipe.empty())
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_handler_creates_and_starts_worker_from_args_after_first_log(self, MockWorker):
         buffer_capacity = 9
         flush_interval = 9
-        handler = LogtailHandler(source_token=self.source_token, buffer_capacity=buffer_capacity, flush_interval=flush_interval)
+        check_interval = 4
+        handler = LogtailHandler(source_token=self.source_token, buffer_capacity=buffer_capacity, flush_interval=flush_interval, check_interval=check_interval)
 
         self.assertFalse(MockWorker.called)
 
@@ -47,11 +50,12 @@ class TestLogtailHandler(unittest.TestCase):
             handler.uploader,
             handler.pipe,
             buffer_capacity,
-            flush_interval
+            flush_interval,
+            check_interval,
         )
         self.assertEqual(handler.flush_thread.start.call_count, 1)
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_emit_starts_thread_if_not_alive(self, MockWorker):
         handler = LogtailHandler(source_token=self.source_token)
 
@@ -67,7 +71,7 @@ class TestLogtailHandler(unittest.TestCase):
 
         self.assertEqual(handler.flush_thread.start.call_count, 2)
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_emit_drops_records_if_configured(self, MockWorker):
         buffer_capacity = 1
         handler = LogtailHandler(
@@ -87,7 +91,7 @@ class TestLogtailHandler(unittest.TestCase):
         self.assertTrue(handler.pipe.empty())
         self.assertEqual(handler.dropcount, 1)
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_emit_does_not_drop_records_if_configured(self, MockWorker):
         buffer_capacity = 1
         handler = LogtailHandler(
@@ -118,7 +122,7 @@ class TestLogtailHandler(unittest.TestCase):
 
         self.assertEqual(handler.dropcount, 0)
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_error_suppression(self, MockWorker):
         buffer_capacity = 1
         handler = LogtailHandler(
@@ -139,7 +143,7 @@ class TestLogtailHandler(unittest.TestCase):
         handler.raise_exceptions = False
         logger.critical('hello')
 
-    @mock.patch('logtail.handler.FlushWorker')
+    @patch('logtail.handler.FlushWorker')
     def test_can_send_unserializable_extra_data(self, MockWorker):
         buffer_capacity = 1
         handler = LogtailHandler(
@@ -158,8 +162,8 @@ class TestLogtailHandler(unittest.TestCase):
         self.assertRegex(log_entry['data']['unserializable'], r'^<tests\.test_handler\.UnserializableObject object at 0x[0-f]+>$')
         self.assertTrue(handler.pipe.empty())
 
-    @mock.patch('logtail.handler.FlushWorker')
-    def test_can_send_unserializable_extra_context(self, MockWorker):
+    @patch('logtail.handler.FlushWorker')
+    def test_can_send_unserializable_context(self, MockWorker):
         buffer_capacity = 1
         handler = LogtailHandler(
             source_token=self.source_token,
@@ -178,6 +182,50 @@ class TestLogtailHandler(unittest.TestCase):
         self.assertRegex(log_entry['context']['data']['unserializable'], r'^<tests\.test_handler\.UnserializableObject object at 0x[0-f]+>$')
         self.assertTrue(handler.pipe.empty())
 
+    @patch('logtail.handler.FlushWorker')
+    def test_can_send_circular_dependency_in_extra_data(self, MockWorker):
+        buffer_capacity = 1
+        handler = LogtailHandler(
+            source_token=self.source_token,
+            buffer_capacity=buffer_capacity
+        )
+
+        logger = logging.getLogger(__name__)
+        logger.handlers = []
+        logger.addHandler(handler)
+        circular_dependency = {'egg': {}}
+        circular_dependency['egg']['chicken'] = circular_dependency
+        logger.info('hello', extra={'data': circular_dependency})
+
+        log_entry = handler.pipe.get()
+
+        self.assertEqual(log_entry['message'], 'hello')
+        self.assertEqual(log_entry['data']['egg']['chicken'], "<omitted circular reference>")
+        self.assertTrue(handler.pipe.empty())
+
+
+    @patch('logtail.handler.FlushWorker')
+    def test_can_send_circular_dependency_in_context(self, MockWorker):
+        buffer_capacity = 1
+        handler = LogtailHandler(
+            source_token=self.source_token,
+            buffer_capacity=buffer_capacity
+        )
+
+        logger = logging.getLogger(__name__)
+        logger.handlers = []
+        logger.addHandler(handler)
+        circular_dependency = {'egg': {}}
+        circular_dependency['egg']['chicken'] = circular_dependency
+        with context(data=circular_dependency):
+            logger.info('hello')
+
+        log_entry = handler.pipe.get()
+
+        self.assertEqual(log_entry['message'], 'hello')
+        self.assertEqual(log_entry['context']['data']['egg']['chicken']['egg'], "<omitted circular reference>")
+        self.assertTrue(handler.pipe.empty())
+
 
 class UnserializableObject(object):
     """ Because this is a custom class, it cannot be serialized into JSON. """

{logtail-python-0.2.9 → logtail_python-0.3.0}/tests/test_uploader.py

@@ -4,6 +4,8 @@ import msgpack
 import mock
 import unittest
 
+from unittest.mock import patch
+
 from logtail.uploader import Uploader
 
 
@@ -12,7 +14,7 @@ class TestUploader(unittest.TestCase):
     source_token = 'dummy_source_token'
     frame = [1, 2, 3]
 
-    @mock.patch('logtail.uploader.requests.Session.post')
+    @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