Skip to content

Commit ff21b62

Browse files
committed
docs(developing): simplify Logging section per review (drop package name, consolidate, guidellm env)
1 parent 66cf2fe commit ff21b62

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

DEVELOPING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -306,17 +306,17 @@ In the future this will be replaced by a configurable untracked file for dev use
306306

307307
## Logging
308308

309-
GuideLLM uses [Loguru](https://github.com/Delgan/loguru) for logging, which is useful for learning how GuideLLM works and for diagnosing problems. Logging is configured entirely through environment variables (or the equivalent `GUIDELLM__LOGGING__*` settings), so no code changes are needed to change what is logged or where it goes.
309+
Logging is controlled entirely through the `GUIDELLM__LOGGING__*` environment variables (or the equivalent settings object), so no code changes are needed to change what is logged or where it goes.
310310

311-
GuideLLM writes to two independent sinks:
311+
Logging is set through two independent outputs:
312312

313-
- **Console logging** is enabled by default and prints human-readable messages (timestamp, level, `module:function:line`, and message) to `stdout`. Its verbosity is controlled by `GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL` (default: `WARNING`).
314-
- **File logging** is disabled by default and turns on as soon as either `GUIDELLM__LOGGING__LOG_FILE` or `GUIDELLM__LOGGING__LOG_FILE_LEVEL` is set. File logs are written as structured JSON (one object per line) for easy parsing, to `GUIDELLM__LOGGING__LOG_FILE` (default: `guidellm.log`) at `GUIDELLM__LOGGING__LOG_FILE_LEVEL` (default: `INFO`).
313+
- **Console logging** is enabled by default and prints human-readable messages (timestamp, level, `module:function:line`, and message) to `stdout`.
314+
- **File logging** is disabled by default and turns on as soon as either `GUIDELLM__LOGGING__LOG_FILE` or `GUIDELLM__LOGGING__LOG_FILE_LEVEL` is set. File logs are written as structured JSON, one object per line.
315315

316-
### Logging environment variables
316+
The variables below control both, including their default levels:
317317

318318
- `GUIDELLM__LOGGING__DISABLED`: Disable logging entirely (default: `false`).
319-
- `GUIDELLM__LOGGING__CLEAR_LOGGERS`: Clear existing loguru loggers before configuring GuideLLM's own (default: `true`).
319+
- `GUIDELLM__LOGGING__CLEAR_LOGGERS`: Clear existing loggers before configuring GuideLLM's own (default: `true`).
320320
- `GUIDELLM__LOGGING__CONSOLE_LOG_LEVEL`: Level for console logging, one of `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` (default: `WARNING`).
321321
- `GUIDELLM__LOGGING__LOG_FILE`: Path to the log file; setting it enables file logging (default: `guidellm.log` when a file level is set, otherwise file logging is off).
322322
- `GUIDELLM__LOGGING__LOG_FILE_LEVEL`: Level for file logging; setting it enables file logging (default: `INFO` when a log file is set, otherwise off).
@@ -335,7 +335,7 @@ Write structured `DEBUG` logs to a file while leaving the console at its default
335335
GUIDELLM__LOGGING__LOG_FILE=guidellm.log GUIDELLM__LOGGING__LOG_FILE_LEVEL=DEBUG guidellm run ...
336336
```
337337

338-
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.
338+
If logging isn't responding to the environment variables, run the `guidellm env` command to validate that the environment variables match and are being set correctly.
339339

340340
## Additional Resources
341341

0 commit comments

Comments
 (0)