chore[python]: Add additional debug logging to background threads (#1689)

Author: angus-langchain

python/langsmith/__init__.py

@@ -20,7 +20,7 @@
     from langsmith.utils import ContextThreadPoolExecutor
 
 # Avoid calling into importlib on every call to __version__
-__version__ = "0.3.33"
+__version__ = "0.3.34"
 version = __version__  # for backwards compatibility
 
 

python/langsmith/_internal/_background_thread.py

@@ -302,15 +302,25 @@ def keep_thread_active() -> bool:
         if not client or (
             hasattr(client, "_manual_cleanup") and client._manual_cleanup
         ):
+            logger.debug("Client is being cleaned up, stopping tracing thread")
             return False
         if not threading.main_thread().is_alive():
             # main thread is dead. should not be active
+            logger.debug("Main thread is dead, stopping tracing thread")
             return False
 
         if hasattr(sys, "getrefcount"):
             # check if client refs count indicates we're the only remaining
             # reference to the client
-            return sys.getrefcount(client) > num_known_refs + len(sub_threads)
+            should_keep_thread = sys.getrefcount(client) > num_known_refs + len(
+                sub_threads
+            )
+            if not should_keep_thread:
+                logger.debug(
+                    "Client refs count indicates we're the only remaining reference "
+                    "to the client, stopping tracing thread",
+                )
+            return should_keep_thread
         else:
             # in PyPy, there is no sys.getrefcount attribute
             # for now, keep thread alive
@@ -349,7 +359,7 @@ def keep_thread_active() -> bool:
             _tracing_thread_handle_batch(
                 client, tracing_queue, next_batch, use_multipart
             )
-        logger.debug("Tracing control thread is shutting down")
+    logger.debug("Tracing control thread is shutting down")
 
 
 def tracing_control_thread_func_compress_parallel(
@@ -381,9 +391,11 @@ def keep_thread_active() -> bool:
         if not client or (
             hasattr(client, "_manual_cleanup") and client._manual_cleanup
         ):
+            logger.debug("Client is being cleaned up, stopping compression thread")
             return False
         if not threading.main_thread().is_alive():
             # main thread is dead. should not be active
+            logger.debug("Main thread is dead, stopping compression thread")
             return False
         if hasattr(sys, "getrefcount"):
             # check if client refs count indicates we're the only remaining
@@ -394,8 +406,13 @@ def keep_thread_active() -> bool:
             active_count = sum(
                 1 for thread in thread_pool if thread is not None and thread.is_alive()
             )
-
-            return sys.getrefcount(client) > num_known_refs + active_count
+            should_keep_thread = sys.getrefcount(client) > num_known_refs + active_count
+            if not should_keep_thread:
+                logger.debug(
+                    "Client refs count indicates we're the only remaining reference "
+                    "to the client, stopping compression thread",
+                )
+            return should_keep_thread
         else:
             # in PyPy, there is no sys.getrefcount attribute
             # for now, keep thread alive
@@ -538,4 +555,4 @@ def _tracing_sub_thread_func(
             _tracing_thread_handle_batch(
                 client, tracing_queue, next_batch, use_multipart
             )
-        logger.debug("Tracing control sub-thread is shutting down")
+    logger.debug("Tracing control sub-thread is shutting down")

python/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "langsmith"
-version = "0.3.33"
+version = "0.3.34"
 description = "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform."
 authors = ["LangChain <[email protected]>"]
 license = "MIT"