From ff438fe515c6ddd547a380203ee48f61a528d957 Mon Sep 17 00:00:00 2001 From: Jared O'Connell Date: Thu, 10 Jul 2025 17:19:12 -0400 Subject: [PATCH 1/2] Fix logging documentation Signed-off-by: Jared O'Connell --- DEVELOPING.md | 18 ++++++++++++++++++ src/guidellm/logger.py | 9 ++++++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index dde51744..838f3719 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -267,6 +267,24 @@ Reference [https://www.npmjs.com/package/jest-runner-groups](jest-runner-groups) */ ``` +### Logging + +Logging is useful for learning how GuideLLM works and finding problems. + +Logging is set using the following environment variables: +- `GUIDELLM__LOGGING__DISABLED`: Disable logging (default: false). +- `GUIDELLM__LOGGING__CLEAR_LOGGERS`: Clear existing loggers + from loguru (default: true). +- `GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL`: Log level for console logging + (default: none, options: DEBUG, INFO, WARNING, ERROR, CRITICAL). +- `GUIDELLM__LOGGING__LOG_FILE`: Path to the log file for file logging + (default: guidellm.log if log file level set else none) +- `GUIDELLM__LOGGING__LOG_FILE_LEVEL`: Log level for file logging + (default: INFO if log file set else none). + +If logging isn't responding to the environment variables, run the `guidellm config` +command to validate that the environment variables match and are being set correctly. + ## Additional Resources - [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project. diff --git a/src/guidellm/logger.py b/src/guidellm/logger.py index f26966c0..ac235c99 100644 --- a/src/guidellm/logger.py +++ b/src/guidellm/logger.py @@ -9,13 +9,16 @@ - GUIDELLM__LOGGING__DISABLED: Disable logging (default: false). - GUIDELLM__LOGGING__CLEAR_LOGGERS: Clear existing loggers from loguru (default: true). - - GUIDELLM__LOGGING__LOG_LEVEL: Log level for console logging + - GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL: Log level for console logging (default: none, options: DEBUG, INFO, WARNING, ERROR, CRITICAL). - - GUIDELLM__LOGGING__FILE: Path to the log file for file logging + - GUIDELLM__LOGGING__LOG_FILE: Path to the log file for file logging (default: guidellm.log if log file level set else none) - - GUIDELLM__LOGGING__FILE_LEVEL: Log level for file logging + - GUIDELLM__LOGGING__LOG_FILE_LEVEL: Log level for file logging (default: INFO if log file set else none). +If logging isn't responding to the environment variables, run the `guidellm config` +command to validate that the environment variables match and are being set correctly. + Usage: from guidellm import logger, configure_logger, LoggerConfig From 8a6ea73cc2969ac467a2ccfeaa9049fcdaabac59 Mon Sep 17 00:00:00 2001 From: Jared O'Connell Date: Thu, 10 Jul 2025 17:25:16 -0400 Subject: [PATCH 2/2] Format markdown Signed-off-by: Jared O'Connell --- DEVELOPING.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/DEVELOPING.md b/DEVELOPING.md index 838f3719..1b1322eb 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -272,18 +272,14 @@ Reference [https://www.npmjs.com/package/jest-runner-groups](jest-runner-groups) Logging is useful for learning how GuideLLM works and finding problems. Logging is set using the following environment variables: + - `GUIDELLM__LOGGING__DISABLED`: Disable logging (default: false). -- `GUIDELLM__LOGGING__CLEAR_LOGGERS`: Clear existing loggers - from loguru (default: true). -- `GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL`: Log level for console logging - (default: none, options: DEBUG, INFO, WARNING, ERROR, CRITICAL). -- `GUIDELLM__LOGGING__LOG_FILE`: Path to the log file for file logging - (default: guidellm.log if log file level set else none) -- `GUIDELLM__LOGGING__LOG_FILE_LEVEL`: Log level for file logging - (default: INFO if log file set else none). - -If logging isn't responding to the environment variables, run the `guidellm config` -command to validate that the environment variables match and are being set correctly. +- `GUIDELLM__LOGGING__CLEAR_LOGGERS`: Clear existing loggers from loguru (default: true). +- `GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL`: Log level for console logging (default: none, options: DEBUG, INFO, WARNING, ERROR, CRITICAL). +- `GUIDELLM__LOGGING__LOG_FILE`: Path to the log file for file logging (default: guidellm.log if log file level set else none) +- `GUIDELLM__LOGGING__LOG_FILE_LEVEL`: Log level for file logging (default: INFO if log file set else none). + +If logging isn't responding to the environment variables, run the `guidellm config` command to validate that the environment variables match and are being set correctly. ## Additional Resources