chore: add pre-commit hook to enforce llama_stack.log logger

Signed-off-by: Mustafa Elbehery <[email protected]>

Author: Elbehery

.pre-commit-config.yaml

@@ -145,6 +145,26 @@ repos:
               echo;
               exit 1;
             } || true
+      - id: check-logger-usage
+        name: Check for proper logger usage (use llama_stack.log instead)
+        entry: bash
+        language: system
+        types: [python]
+        pass_filenames: true
+        args:
+          - -c
+          - |
+            grep -EnH '^[^#]*\b(import logging|from logging\b)' "$@" | grep -v '# allow-direct-logging' && {
+              echo;
+              echo "❌ Do not use 'import logging' or 'from logging import'.";
+              echo "   Use the custom logger instead:";
+              echo "     from llama_stack.log import get_logger";
+              echo "     logger = get_logger(name=__name__, category=\"core\")";
+              echo;
+              echo "   If direct logging is truly needed, add: # allow-direct-logging";
+              echo;
+              exit 1;
+            } || true
 
 ci:
     autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

llama_stack/distribution/build.py

@@ -5,7 +5,6 @@
 # the root directory of this source tree.
 
 import importlib.resources
-import logging
 import sys
 from pathlib import Path
 
@@ -17,11 +16,12 @@
 from llama_stack.distribution.external import load_external_apis
 from llama_stack.distribution.utils.exec import run_command
 from llama_stack.distribution.utils.image_types import LlamaStackImageType
+from llama_stack.log import get_logger
+
+logger = get_logger(name=__name__, category="core")
 from llama_stack.providers.datatypes import Api
 from llama_stack.templates.template import DistributionTemplate
 
-log = logging.getLogger(__name__)
-
 # These are the dependencies needed by the distribution server.
 # `llama-stack` is automatically installed by the installation script.
 SERVER_DEPENDENCIES = [
@@ -170,7 +170,7 @@ def build_image(
     return_code = run_command(args)
 
     if return_code != 0:
-        log.error(
+        logger.error(
             f"Failed to build target {image_name} with return code {return_code}",
         )
 

llama_stack/distribution/request_headers.py

@@ -6,15 +6,15 @@
 
 import contextvars
 import json
-import logging
 from contextlib import AbstractContextManager
 from typing import Any
 
 from llama_stack.distribution.datatypes import User
+from llama_stack.log import get_logger
 
-from .utils.dynamic import instantiate_class_type
+logger = get_logger(name=__name__, category="core")
 
-log = logging.getLogger(__name__)
+from .utils.dynamic import instantiate_class_type
 
 # Context variable for request provider data and auth attributes
 PROVIDER_DATA_VAR = contextvars.ContextVar("provider_data", default=None)
@@ -61,7 +61,7 @@ def get_request_provider_data(self) -> Any:
             provider_data = validator(**val)
             return provider_data
         except Exception as e:
-            log.error(f"Error parsing provider data: {e}")
+            logger.error(f"Error parsing provider data: {e}")
             return None
 
 
@@ -83,7 +83,7 @@ def parse_request_provider_data(headers: dict[str, str]) -> dict[str, Any] | Non
     try:
         return json.loads(val)
     except json.JSONDecodeError:
-        log.error("Provider data not encoded as a JSON object!")
+        logger.error("Provider data not encoded as a JSON object!")
         return None
 
 

llama_stack/distribution/utils/exec.py

@@ -4,21 +4,20 @@
 # This source code is licensed under the terms described in the LICENSE file in
 # the root directory of this source tree.
 
-import logging
+import importlib
+import json
 import os
 import signal
 import subprocess
 import sys
+from pathlib import Path
 
 from termcolor import cprint
 
-log = logging.getLogger(__name__)
-
-import importlib
-import json
-from pathlib import Path
-
 from llama_stack.distribution.utils.image_types import LlamaStackImageType
+from llama_stack.log import get_logger
+
+logger = get_logger(name=__name__, category="core")
 
 
 def formulate_run_args(image_type: str, image_name: str) -> list[str]:
@@ -119,7 +118,7 @@ def run_command(command: list[str]) -> int:
     def sigint_handler(signum, frame):
         nonlocal ctrl_c_pressed
         ctrl_c_pressed = True
-        log.info("\nCtrl-C detected. Aborting...")
+        logger.info("\nCtrl-C detected. Aborting...")
 
     try:
         # Set up the signal handler
@@ -133,10 +132,10 @@ def sigint_handler(signum, frame):
         )
         return result.returncode
     except subprocess.SubprocessError as e:
-        log.error(f"Subprocess error: {e}")
+        logger.error(f"Subprocess error: {e}")
         return 1
     except Exception as e:
-        log.exception(f"Unexpected error: {e}")
+        logger.exception(f"Unexpected error: {e}")
         return 1
     finally:
         # Restore the original signal handler

llama_stack/distribution/utils/prompt_for_config.py

@@ -6,15 +6,16 @@
 
 import inspect
 import json
-import logging
 from enum import Enum
 from typing import Annotated, Any, Literal, Union, get_args, get_origin
 
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
 from pydantic_core import PydanticUndefinedType
 
-log = logging.getLogger(__name__)
+from llama_stack.log import get_logger
+
+logger = get_logger(name=__name__, category="core")
 
 
 def is_list_of_primitives(field_type):
@@ -107,7 +108,7 @@ def prompt_for_discriminated_union(
 
         if discriminator_value in type_map:
             chosen_type = type_map[discriminator_value]
-            log.info(f"\nConfiguring {chosen_type.__name__}:")
+            logger.info(f"\nConfiguring {chosen_type.__name__}:")
 
             if existing_value and (getattr(existing_value, discriminator) != discriminator_value):
                 existing_value = None
@@ -117,7 +118,7 @@ def prompt_for_discriminated_union(
             setattr(sub_config, discriminator, discriminator_value)
             return sub_config
         else:
-            log.error(f"Invalid {discriminator}. Please try again.")
+            logger.error(f"Invalid {discriminator}. Please try again.")
 
 
 # This is somewhat elaborate, but does not purport to be comprehensive in any way.
@@ -166,7 +167,7 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                     config_data[field_name] = validated_value
                     break
                 except KeyError:
-                    log.error(f"Invalid choice. Please choose from: {', '.join(e.name for e in field_type)}")
+                    logger.error(f"Invalid choice. Please choose from: {', '.join(e.name for e in field_type)}")
             continue
 
         if is_discriminated_union(field):
@@ -179,7 +180,7 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                 config_data[field_name] = None
                 continue
             nested_type = get_non_none_type(field_type)
-            log.info(f"Entering sub-configuration for {field_name}:")
+            logger.info(f"Entering sub-configuration for {field_name}:")
             config_data[field_name] = prompt_for_config(nested_type, existing_value)
         elif is_optional(field_type) and is_discriminated_union(get_non_none_type(field_type)):
             prompt = f"Do you want to configure {field_name}? (y/n): "
@@ -193,7 +194,7 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                 existing_value,
             )
         elif can_recurse(field_type):
-            log.info(f"\nEntering sub-configuration for {field_name}:")
+            logger.info(f"\nEntering sub-configuration for {field_name}:")
             config_data[field_name] = prompt_for_config(
                 field_type,
                 existing_value,
@@ -220,7 +221,7 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                         config_data[field_name] = None
                         break
                     else:
-                        log.error("This field is required. Please provide a value.")
+                        logger.error("This field is required. Please provide a value.")
                         continue
                 else:
                     try:
@@ -242,10 +243,10 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                                 value = [element_type(item) for item in value]
 
                             except json.JSONDecodeError:
-                                log.error('Invalid JSON. Please enter a valid JSON-encoded list e.g., ["foo","bar"]')
+                                logger.error('Invalid JSON. Please enter a valid JSON-encoded list e.g., ["foo","bar"]')
                                 continue
                             except ValueError as e:
-                                log.error(f"{str(e)}")
+                                logger.error(f"{str(e)}")
                                 continue
 
                         elif get_origin(field_type) is dict:
@@ -255,7 +256,7 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                                     raise ValueError("Input must be a JSON-encoded dictionary")
 
                             except json.JSONDecodeError:
-                                log.error("Invalid JSON. Please enter a valid JSON-encoded dict.")
+                                logger.error("Invalid JSON. Please enter a valid JSON-encoded dict.")
                                 continue
 
                         # Convert the input to the correct type
@@ -268,7 +269,9 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                             value = field_type(user_input)
 
                     except ValueError:
-                        log.error(f"Invalid input. Expected type: {getattr(field_type, '__name__', str(field_type))}")
+                        logger.error(
+                            f"Invalid input. Expected type: {getattr(field_type, '__name__', str(field_type))}"
+                        )
                         continue
 
                 try:
@@ -277,6 +280,6 @@ def prompt_for_config(config_type: type[BaseModel], existing_config: BaseModel |
                     config_data[field_name] = validated_value
                     break
                 except ValueError as e:
-                    log.error(f"Validation error: {str(e)}")
+                    logger.error(f"Validation error: {str(e)}")
 
     return config_type(**config_data)

llama_stack/log.py

@@ -4,11 +4,11 @@
 # This source code is licensed under the terms described in the LICENSE file in
 # the root directory of this source tree.
 
-import logging
+import logging  # allow-direct-logging
 import os
 import re
 import sys
-from logging.config import dictConfig
+from logging.config import dictConfig  # allow-direct-logging
 
 from rich.console import Console
 from rich.errors import MarkupError

llama_stack/models/llama/llama4/quantization/loader.py

@@ -4,7 +4,6 @@
 # This source code is licensed under the terms described in the LICENSE file in
 # the root directory of this source tree.
 
-import logging
 import os
 from collections.abc import Callable
 
@@ -13,12 +12,12 @@
 from torch import Tensor, nn
 from torch.nn import functional as F
 
+from llama_stack.log import log
+
 from ...datatypes import QuantizationMode
 from ..model import Transformer, TransformerBlock
 from ..moe import MoE
 
-log = logging.getLogger(__name__)
-
 
 def swiglu_wrapper_no_reduce(
     self,

llama_stack/models/llama/quantize_impls.py

@@ -6,9 +6,8 @@
 
 # type: ignore
 import collections
-import logging
 
-log = logging.getLogger(__name__)
+from llama_stack.log import log
 
 try:
     import fbgemm_gpu.experimental.gen_ai  # noqa: F401

llama_stack/providers/inline/agents/meta_reference/persistence.py

@@ -5,7 +5,6 @@
 # the root directory of this source tree.
 
 import json
-import logging
 import uuid
 from datetime import UTC, datetime
 
@@ -14,9 +13,10 @@
 from llama_stack.distribution.access_control.datatypes import AccessRule
 from llama_stack.distribution.datatypes import User
 from llama_stack.distribution.request_headers import get_authenticated_user
-from llama_stack.providers.utils.kvstore import KVStore
+from llama_stack.log import get_logger
 
-log = logging.getLogger(__name__)
+logger = get_logger(name=__name__, category="agents")
+from llama_stack.providers.utils.kvstore import KVStore
 
 
 class AgentSessionInfo(Session):
@@ -126,7 +126,7 @@ async def get_session_turns(self, session_id: str) -> list[Turn]:
                 turn = Turn(**json.loads(value))
                 turns.append(turn)
             except Exception as e:
-                log.error(f"Error parsing turn: {e}")
+                logger.error(f"Error parsing turn: {e}")
                 continue
 
         # The kvstore does not guarantee order, so we sort by started_at
@@ -193,7 +193,7 @@ async def list_sessions(self) -> list[Session]:
                 session_info = Session(**json.loads(value))
                 sessions.append(session_info)
             except Exception as e:
-                log.error(f"Error parsing session info: {e}")
+                logger.error(f"Error parsing session info: {e}")
                 continue
         return sessions
 

llama_stack/providers/inline/agents/meta_reference/safety.py

@@ -5,13 +5,13 @@
 # the root directory of this source tree.
 
 import asyncio
-import logging
 
 from llama_stack.apis.inference import Message
 from llama_stack.apis.safety import Safety, SafetyViolation, ViolationLevel
-from llama_stack.providers.utils.telemetry import tracing
+from llama_stack.log import get_logger
 
-log = logging.getLogger(__name__)
+logger = get_logger(name=__name__, category="agents")
+from llama_stack.providers.utils.telemetry import tracing
 
 
 class SafetyException(Exception):  # noqa: N818
@@ -49,4 +49,4 @@ async def run_shield_with_span(identifier: str):
             if violation.violation_level == ViolationLevel.ERROR:
                 raise SafetyException(violation)
             elif violation.violation_level == ViolationLevel.WARN:
-                log.warning(f"[Warn]{identifier} raised a warning")
+                logger.warning(f"[Warn]{identifier} raised a warning")