Report plugin name in dedicated loggers

Author: ncoghlan

src/lmstudio/_logging.py

@@ -147,5 +147,7 @@ def critical(
         self._log(logging.CRITICAL, msg, exc_info, stack_info, stacklevel, event_dict)
 
 
-def get_logger(name: str, /, *args: Any, **kwds: Any) -> StructuredLogger:
+def new_logger(name: str, /, *args: Any, **kwds: Any) -> StructuredLogger:
+    # Loggers contain runtime state, so they are NOT shared based on their names
+    # Function name reflects this to avoid false expectations from stdlib logging
     return StructuredLogger(logging.getLogger(name, *args, **kwds))

src/lmstudio/_ws_impl.py

@@ -32,7 +32,7 @@
 from .schemas import DictObject
 from .json_api import LMStudioWebsocket, LMStudioWebsocketError
 
-from ._logging import get_logger, LogEventContext
+from ._logging import new_logger, LogEventContext
 
 
 # Allow the core client websocket management to be shared across all SDK interaction APIs
@@ -281,7 +281,7 @@ def call_in_background(self, func: Callable[[], Any]) -> None:
 class AsyncWebsocketThread(BackgroundThread):
     def __init__(self, log_context: LogEventContext | None = None) -> None:
         super().__init__(task_target=self._log_thread_execution)
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, thread_id=self.name)
 
     async def _log_thread_execution(self) -> None:
@@ -322,8 +322,8 @@ def __init__(
         self._ws_disconnected = asyncio.Event()
         self._rx_task: asyncio.Task[None] | None = None
         self._enqueue_message = enqueue_message
-        self._logger = get_logger(type(self).__name__)
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = new_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context)
 
     async def connect(self) -> bool:

src/lmstudio/async_api.py

@@ -103,7 +103,7 @@
     ModelCompatibilityType,
 )
 
-from ._logging import get_logger, LogEventContext
+from ._logging import new_logger, LogEventContext
 
 # Only the async API itself is published from
 # this module. Anything needed for type hints
@@ -197,7 +197,7 @@ def __init__(
         """Initialize asynchronous remote procedure call."""
         self._rx_queue = rx_queue
         self._rpc = RemoteCallHandler(call_id, log_context, notice_prefix)
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, call_id=call_id)
 
     def get_rpc_message(

src/lmstudio/json_api.py

@@ -117,7 +117,7 @@
     RepositoryRpcSearchModelsParameter,
     SerializedLMSExtendedError,
 )
-from ._logging import get_logger, LogEventContext, StructuredLogger
+from ._logging import new_logger, LogEventContext, StructuredLogger
 
 # The sync and async modules publish the main SDK client API.
 # From here, we publish everything that might be needed
@@ -661,7 +661,7 @@ def __init__(
         # Channel processing state tracking
         self._is_finished = False
         self._result: T | None = None
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(endpoint=self._API_ENDPOINT)
 
     @property
@@ -1602,7 +1602,7 @@ def __init__(
         self._is_finished = False
         self._channel_id = channel_id
         self._endpoint = endpoint
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, channel_id=channel_id)
 
     @property
@@ -1688,7 +1688,7 @@ def __init__(
     ) -> None:
         """Initialize websocket remote procedure call."""
         self._call_id = call_id
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, call_id=call_id)
         self._notice_prefix = notice_prefix
 
@@ -1783,7 +1783,7 @@ def __init__(
         """Initialize I/O independent websocket details."""
         self._ws_url = ws_url
         self._auth_details = auth_details
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, ws_url=ws_url)
         self._mux = MultiplexingManager(logger)
         # Subclasses handle actually creating a websocket instance
@@ -2055,7 +2055,7 @@ def __init__(self, model_identifier: str, session: TSession) -> None:
         """Initialize the LM Studio model reference."""
         self.identifier = model_identifier
         self._session = session
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(model_identifier=model_identifier)
 
     def __repr__(self) -> str:

src/lmstudio/plugin/_dev_runner.py

@@ -93,7 +93,7 @@ def handle_rx_event(self, event: DevPluginRegistrationRxEvent) -> None:
 
 class DevPluginClient(PluginClient):
     def _get_registration_endpoint(self) -> DevPluginRegistrationEndpoint:
-        return DevPluginRegistrationEndpoint(self._owner, self._name)
+        return DevPluginRegistrationEndpoint(self.owner, self.name)
 
     @asynccontextmanager
     async def register_dev_plugin(self) -> AsyncGenerator[tuple[str, str], None]:

src/lmstudio/plugin/hooks/prompt_preprocessor.py

@@ -15,7 +15,7 @@
 
 from anyio import create_task_group
 
-from ..._logging import get_logger
+from ..._logging import new_logger
 from ...schemas import DictObject, EmptyDict, ValidationError
 from ...history import UserMessage, UserMessageDict
 from ...json_api import (
@@ -187,14 +187,16 @@ async def notify_done(self, message: str) -> None:
 
 
 async def run_prompt_preprocessor(
+    plugin_name: str,
     hook_impl: PromptPreprocessorHook,
     plugin_config_schema: type[BaseConfigSchema],
     global_config_schema: type[BaseConfigSchema],
     session: AsyncSessionPlugins,
     notify_ready: Callable[[], Any],
 ) -> None:
     """Accept prompt preprocessing requests."""
-    logger = get_logger(__name__)
+    logger = new_logger(__name__)
+    logger.update_context(plugin_name=plugin_name)
     endpoint = PromptPreprocessingEndpoint()
     async with session._create_channel(endpoint) as channel:
         notify_ready()

src/lmstudio/plugin/hooks/token_generator.py

@@ -6,7 +6,9 @@
     PluginsChannelSetGeneratorToClientPacketGenerate as TokenGenerationRequest,
 )
 
+from ..config_schemas import BaseConfigSchema
 from .common import (
+    AsyncSessionPlugins,
     HookController,
     TPluginConfigSchema,
     TGlobalConfigSchema,
@@ -16,7 +18,7 @@
 __all__ = [
     "TokenGeneratorController",
     "TokenGeneratorHook",
-    # "run_token_generator",
+    "run_token_generator",
 ]
 
 
@@ -27,3 +29,15 @@ class TokenGeneratorController(
 
 
 TokenGeneratorHook = Callable[[TokenGeneratorController[Any, Any]], Awaitable[None]]
+
+
+async def run_token_generator(
+    plugin_name: str,
+    hook_impl: TokenGeneratorHook,
+    plugin_config_schema: type[BaseConfigSchema],
+    global_config_schema: type[BaseConfigSchema],
+    session: AsyncSessionPlugins,
+    notify_ready: Callable[[], Any],
+) -> None:
+    """Accept token generation requests."""
+    raise NotImplementedError

src/lmstudio/plugin/hooks/tools_provider.py

@@ -11,7 +11,9 @@
     PluginsChannelSetToolsProviderToClientPacketInitSession as ProvideToolsInitSession,
 )
 
+from ..config_schemas import BaseConfigSchema
 from .common import (
+    AsyncSessionPlugins,
     HookController,
     TPluginConfigSchema,
     TGlobalConfigSchema,
@@ -21,7 +23,7 @@
 __all__ = [
     "ToolsProviderController",
     "ToolsProviderHook",
-    # "run_tools_provider",
+    "run_tools_provider",
 ]
 
 
@@ -34,3 +36,15 @@ class ToolsProviderController(
 ToolsProviderHook = Callable[
     [ToolsProviderController[Any, Any]], Awaitable[Iterable[ToolDefinition]]
 ]
+
+
+async def run_tools_provider(
+    plugin_name: str,
+    hook_impl: ToolsProviderHook,
+    plugin_config_schema: type[BaseConfigSchema],
+    global_config_schema: type[BaseConfigSchema],
+    session: AsyncSessionPlugins,
+    notify_ready: Callable[[], Any],
+) -> None:
+    """Accept tools provider session requests."""
+    raise NotImplementedError

src/lmstudio/plugin/runner.py

@@ -16,7 +16,7 @@
 
 from anyio import create_task_group
 
-from .._logging import get_logger
+from .._logging import new_logger
 from ..sdk_api import LMStudioFileNotFoundError, sdk_public_api
 from ..schemas import DictObject
 from ..async_api import AsyncClient
@@ -51,6 +51,7 @@
 ReadyCallback: TypeAlias = Callable[[], Any]
 HookRunner: TypeAlias = Callable[
     [
+        str,  # Plugin name
         THookImpl,
         type[TPluginConfigSchema],
         type[TGlobalConfigSchema],
@@ -92,9 +93,9 @@ def __init__(
             raise LMStudioPluginInitError(
                 f'Invalid manifest runner: {manifest["runner"]} (expected "python")'
             )
-        self._owner = manifest["owner"]
-        self._name = name = manifest["name"]
-        self._logger = logger = get_logger(__name__)
+        self.owner = manifest["owner"]
+        self.name = name = manifest["name"]
+        self._logger = logger = new_logger(__name__)
         logger.update_context(plugin=name)
 
     _ALL_SESSIONS = (
@@ -124,6 +125,7 @@ async def _run_hook_impl(
     ) -> None:
         """Run the given hook implementation."""
         await hook_runner(
+            self.name,
             hook_impl,
             plugin_config_schema,
             global_config_schema,
@@ -179,6 +181,7 @@ async def run_plugin(self, *, allow_local_imports: bool = False) -> int:
             raise LMStudioFileNotFoundError(source_path)
         # TODO: Consider passing this logger to hook runners (instead of each creating their own)
         logger = self._logger
+        logger.update_context(plugin_name=self.name)
         logger.info(f"Running {source_path}")
         if allow_local_imports:
             # We don't try to revert the path change, as that can have odd side-effects
@@ -208,7 +211,7 @@ async def run_plugin(self, *, allow_local_imports: bool = False) -> int:
                     hook_ready_event.set,
                 )
             )
-        plugin = self._name
+        plugin = self.name
         if not implemented_hooks:
             print(
                 f"No plugin hooks defined in {plugin!r}, "

src/lmstudio/sync_api.py

@@ -121,7 +121,7 @@
     ModelCompatibilityType,
 )
 
-from ._logging import get_logger, LogEventContext
+from ._logging import new_logger, LogEventContext
 
 # Only the sync API itself is published from
 # this module. Anything needed for type hints
@@ -223,7 +223,7 @@ def __init__(
         """Initialize synchronous remote procedure call."""
         self._rx_queue = rx_queue
         self._rpc = RemoteCallHandler(call_id, log_context, notice_prefix)
-        self._logger = logger = get_logger(type(self).__name__)
+        self._logger = logger = new_logger(type(self).__name__)
         logger.update_context(log_context, call_id=call_id)
 
     def get_rpc_message(