logtail-python 0.4.0__py2.py3-none-any.whl → 0.4.2__py2.py3-none-any.whl

logtail/__init__.py

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

logtail/flusher.py

@@ -9,6 +9,14 @@ from .compat import queue
 RETRY_SCHEDULE = (1, 10, 60)  # seconds
 
 
+class TransportFrame(dict):
+    """A record logged by a flush worker itself, i.e. urllib3 describing our own upload.
+
+    It rides along with the next batch of regular records but never triggers an upload
+    on its own, since that upload would log again and the queue would never drain.
+    """
+
+
 class FlushWorker(threading.Thread):
     def __init__(self, upload, pipe, buffer_capacity, flush_interval, check_interval):
         threading.Thread.__init__(self)
@@ -71,7 +79,7 @@ class FlushWorker(threading.Thread):
         # count) and sends them to the Better Stack endpoint all at once. If the
         # request fails in a way that can be retried, it is retried with an
         # exponential backoff in between attempts.
-        if frame:
+        if frame and not all(isinstance(entry, TransportFrame) for entry in frame):
             response = None
             for delay in RETRY_SCHEDULE + (None, ):
                 response = self.upload(frame)
@@ -80,18 +88,46 @@ class FlushWorker(threading.Thread):
                 if delay is not None:
                     time.sleep(delay)
 
-            if response.status_code == 500 and getattr(response, "exception") != None:
+            # A network error surfaces as a Fake500 that carries an `exception`
+            # attribute; a genuine server HTTP 500 is a real `requests.Response`
+            # that has no such attribute. Use a default so the latter doesn't
+            # raise AttributeError here and kill the flush thread (dropping all
+            # subsequent logs for the life of the process).
+            if response.status_code == 500 and getattr(response, "exception", None) is not 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):
+    def flush(self, timeout=None):
+        """Block until the worker has drained the queue.
+
+        If ``timeout`` is given (in seconds), return after at most that much
+        wall time has elapsed even if the queue is still non-empty. Returns
+        ``True`` if the queue was drained, ``False`` if the timeout fired.
+
+        The bound matters when the caller holds the global logging lock, as
+        ``logging.config.dictConfig()`` does while it flushes and closes the
+        handlers it replaces: if this worker is inside an upload whose urllib3
+        ``debug()`` call needs that same lock, an unbounded wait deadlocks the
+        process. It also keeps a slow or unreachable endpoint from stalling a
+        shutdown forever.
+        """
         self._flushing = True
-        while not self._clean or not self.pipe.empty():
-            time.sleep(self.check_interval)
-        self._flushing = False
+        try:
+            deadline = None if timeout is None else time.time() + timeout
+            while not self._clean or not self.pipe.empty():
+                if deadline is not None and time.time() >= deadline:
+                    return False
+                time.sleep(self.check_interval)
+            return True
+        finally:
+            self._flushing = False
+
+def in_flush_worker():
+    return isinstance(threading.current_thread(), FlushWorker)
+
 
 def _initial_time_remaining(flush_interval):
     return flush_interval

logtail/handler.py

@@ -2,10 +2,12 @@
 from __future__ import print_function, unicode_literals
 import logging
 import json
+import os
+import weakref
 
 from .compat import queue
 from .helpers import DEFAULT_CONTEXT
-from .flusher import FlushWorker
+from .flusher import FlushWorker, TransportFrame, in_flush_worker
 from .uploader import Uploader
 from .frame import create_frame
 
@@ -17,6 +19,10 @@ DEFAULT_RAISE_EXCEPTIONS = False
 DEFAULT_DROP_EXTRA_EVENTS = True
 DEFAULT_INCLUDE_EXTRA_ATTRIBUTES = True
 DEFAULT_TIMEOUT = 30
+DEFAULT_FLUSH_TIMEOUT = 30
+
+
+_handlers = weakref.WeakSet()
 
 
 class LogtailHandler(logging.Handler):
@@ -31,6 +37,7 @@ class LogtailHandler(logging.Handler):
                  include_extra_attributes=DEFAULT_INCLUDE_EXTRA_ATTRIBUTES,
                  context=DEFAULT_CONTEXT,
                  timeout=DEFAULT_TIMEOUT,
+                 flush_timeout=DEFAULT_FLUSH_TIMEOUT,
                  level=logging.NOTSET):
         super(LogtailHandler, self).__init__(level=level)
         self.source_token = source_token
@@ -47,9 +54,11 @@ class LogtailHandler(logging.Handler):
         self.flush_interval = flush_interval
         self.check_interval = check_interval
         self.raise_exceptions = raise_exceptions
+        self.flush_timeout = flush_timeout
         self.dropcount = 0
         # Do not initialize the flush thread yet because it causes issues on Render.
         self.flush_thread = None
+        _handlers.add(self)
 
     def ensure_flush_thread_alive(self):
         if self.flush_thread and self.flush_thread.is_alive():
@@ -71,8 +80,12 @@ class LogtailHandler(logging.Handler):
             message = self.format(record)
             frame = create_frame(record, message, self.context, include_extra_attributes=self.include_extra_attributes)
             serializable_frame = json.loads(json.dumps(frame, default=str))
+            transport = in_flush_worker()
+            if transport:
+                serializable_frame = TransportFrame(serializable_frame)
             try:
-                self.pipe.put(serializable_frame, block=(not self.drop_extra_events))
+                # The flush worker must never block on its own queue, so its records are dropped when full.
+                self.pipe.put(serializable_frame, block=(not self.drop_extra_events) and not transport)
             except queue.Full:
                 # Only raised when not blocking, which means that extra events
                 # should be dropped.
@@ -83,4 +96,22 @@ class LogtailHandler(logging.Handler):
 
     def flush(self):
         if self.flush_thread and self.flush_thread.is_alive():
-             self.flush_thread.flush()
+            if not self.flush_thread.flush(timeout=self.flush_timeout):
+                print('Gave up waiting for Better Stack uploads after {}s, logs are still buffered'.format(self.flush_timeout))
+
+    def _reset_after_fork(self):
+        # A forked child inherits the parent's queue with whatever was still buffered in it,
+        # a flush thread object whose thread does not exist in the child, and an HTTP session
+        # whose socket it shares with the parent, so it starts over with fresh ones.
+        self.pipe = queue.Queue(maxsize=self.buffer_capacity)
+        self.flush_thread = None
+        self.uploader.reset()
+
+
+def _reset_handlers_after_fork():
+    for handler in _handlers:
+        handler._reset_after_fork()
+
+
+if hasattr(os, 'register_at_fork'):
+    os.register_at_fork(after_in_child=_reset_handlers_after_fork)

logtail/rq.py

@@ -0,0 +1,29 @@
+# coding: utf-8
+from __future__ import print_function, unicode_literals
+import logging
+
+import rq
+
+from .handler import LogtailHandler
+
+
+class Worker(rq.Worker):
+    """An RQ worker that sends buffered log records after every job.
+
+    RQ runs each job in a forked work horse and ends it with os._exit(), which skips the
+    interpreter shutdown that would otherwise let LogtailHandler flush. Use it with
+    `rq worker --worker-class logtail.rq.Worker` or `RQ = {"WORKER_CLASS": "logtail.rq.Worker"}`
+    in django-rq.
+    """
+
+    def perform_job(self, job, queue):
+        try:
+            return super(Worker, self).perform_job(job, queue)
+        finally:
+            for handler in _logtail_handlers():
+                handler.flush()
+
+
+def _logtail_handlers():
+    loggers = [logging.getLogger()] + [logger for logger in logging.Logger.manager.loggerDict.values() if isinstance(logger, logging.Logger)]
+    return {handler for logger in loggers for handler in logger.handlers if isinstance(handler, LogtailHandler)}

logtail/uploader.py

@@ -1,7 +1,9 @@
 # coding: utf-8
 from __future__ import print_function, unicode_literals
+import os
 import msgpack
 import requests
+import requests.utils
 
 class Fake500(object):
     def __init__(self, exception):
@@ -13,11 +15,17 @@ class Uploader(object):
         self.source_token = source_token
         self.host = host
         self.timeout = timeout
-        self.session = requests.Session()
+        # requests would otherwise ask the environment, and on macOS SystemConfiguration, for
+        # proxy settings on every request. Resolving them once here keeps the flush thread out
+        # of CoreFoundation, which refuses to run in a child forked from a multithreaded
+        # process, such as an RQ work horse. The CA bundle variables follow the same rule.
+        self.proxies = requests.utils.get_environ_proxies(host)
+        self.verify = os.environ.get('REQUESTS_CA_BUNDLE') or os.environ.get('CURL_CA_BUNDLE') or True
         self.headers = {
             'Authorization': 'Bearer %s' % source_token,
             'Content-Type': 'application/msgpack',
         }
+        self.session = self._new_session()
 
     def __call__(self, frame):
         data = msgpack.packb(frame, use_bin_type=True)
@@ -25,3 +33,15 @@ class Uploader(object):
             return self.session.post(self.host, data=data, headers=self.headers, timeout=self.timeout)
         except requests.RequestException as e:
             return Fake500(e)
+
+    def reset(self):
+        # A forked child shares the parent's pooled socket, so it needs a session of its own,
+        # built from the settings resolved above rather than looked up again.
+        self.session = self._new_session()
+
+    def _new_session(self):
+        session = requests.Session()
+        session.trust_env = False
+        session.proxies = self.proxies
+        session.verify = self.verify
+        return session

{logtail_python-0.4.0.dist-info → logtail_python-0.4.2.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: logtail-python
-Version: 0.4.0
+Version: 0.4.2
 Summary: Better Stack client library
 Home-page: https://github.com/logtail/logtail-python
-Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.0
+Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.2
 Author: Logtail
 Author-email: hello@logtail.com
 License: ISC
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10

logtail_python-0.4.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+logtail/__init__.py,sha256=4glP1HM13UrMvg1eNN_C4MspQPuKyztVnktGcqsFTuA,252
+logtail/compat.py,sha256=KbZmcmDpj_vbMotp16pADPwJ1FkEHGDNjKbOfCy-c10,141
+logtail/flusher.py,sha256=bPSCvKNniXBZWYY5AVZ0w6lFkxswe739Ooa3ZAj608s,5987
+logtail/formatter.py,sha256=nk4W1G95P19ijylPBJ8D9FlO_qbh3tfbv7xzCSfpDN8,968
+logtail/frame.py,sha256=p7vVYcajZvjH4FJDt4ADLfYljVbQXKTGKk3kFec5JUs,3335
+logtail/handler.py,sha256=Dg4XKhe1bJITz4XBK9JymmNa0cTV6bCcobHeFExlFws,4495
+logtail/helpers.py,sha256=ezDTLsTBAtCtIh_XptSYOiBrZFa-E9wo2SWTnjKgOOU,1156
+logtail/rq.py,sha256=SEjVwjp8lRLab2F0StdssBQ0-vFK1CekEgYwkSICBeo,1023
+logtail/uploader.py,sha256=5oeNxmnyogq1w9MoK2YkxQGxQy_bJ-yS7RqWzltQrKY,1873
+logtail_python-0.4.2.dist-info/licenses/LICENSE.md,sha256=aCBMqxfm7QNyFR9JiJ2GSMvhAURXN2E0yTcYNQloqI0,737
+logtail_python-0.4.2.dist-info/METADATA,sha256=km7pAQqucdR1TGjol0bHQyw5qqeqowG-CTFEvafH44Y,2480
+logtail_python-0.4.2.dist-info/WHEEL,sha256=4YBfCYNH4wlLpv3pzq1hbEuIlXA4WJabKLFurZ7eTL0,109
+logtail_python-0.4.2.dist-info/top_level.txt,sha256=QZIbQogN1yFBgjiJ-8NlYArVCL00gBoYbEUT_Ew8l-Q,8
+logtail_python-0.4.2.dist-info/RECORD,,

{logtail_python-0.4.0.dist-info → logtail_python-0.4.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

logtail_python-0.4.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-logtail/__init__.py,sha256=lz_ouCpEkpsK8Lq9fCQ7Sqj8xbowot6JzNZGFeEfOrI,252
-logtail/compat.py,sha256=KbZmcmDpj_vbMotp16pADPwJ1FkEHGDNjKbOfCy-c10,141
-logtail/flusher.py,sha256=KKb4IEuPC_XGKaNBrbMEiwc-X4MKsYURPjY7PqR3v4k,4176
-logtail/formatter.py,sha256=nk4W1G95P19ijylPBJ8D9FlO_qbh3tfbv7xzCSfpDN8,968
-logtail/frame.py,sha256=p7vVYcajZvjH4FJDt4ADLfYljVbQXKTGKk3kFec5JUs,3335
-logtail/handler.py,sha256=9PNJPSc2S3W5uQADKE4iDFH16A7BZW90D-m7aR66Mo4,3188
-logtail/helpers.py,sha256=ezDTLsTBAtCtIh_XptSYOiBrZFa-E9wo2SWTnjKgOOU,1156
-logtail/uploader.py,sha256=Ilhh8wuAGlz1YJcQpzXtFqwD-2RYmuamKv3dFNoTWUg,868
-logtail_python-0.4.0.dist-info/licenses/LICENSE.md,sha256=aCBMqxfm7QNyFR9JiJ2GSMvhAURXN2E0yTcYNQloqI0,737
-logtail_python-0.4.0.dist-info/METADATA,sha256=Bwsctru3-I0ZkrvKuukF6j1jDB7P1nz5OYyBmBsw79M,2429
-logtail_python-0.4.0.dist-info/WHEEL,sha256=TdQ5LtNwLuxTCjgxN51AgdU5w-KkB9ttmLbzjTH02pg,109
-logtail_python-0.4.0.dist-info/top_level.txt,sha256=QZIbQogN1yFBgjiJ-8NlYArVCL00gBoYbEUT_Ew8l-Q,8
-logtail_python-0.4.0.dist-info/RECORD,,