Fix logging documentation #226
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaredoconnell
force-pushed
the
fix-logging-docs
branch
from
4986d4d to
7b03b22
Compare
Signed-off-by: Jared O'Connell <[email protected]>
jaredoconnell
force-pushed
the
fix-logging-docs
branch
from
7b03b22 to
ff438fe
Compare
Signed-off-by: Jared O'Connell <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR corrects and centralizes the logging environment variable documentation by renaming outdated variable names and adding troubleshooting guidance.
- Renamed logging variables in the code docstring (LOG_LEVEL → CONSOLE_LOG_LEVEL, FILE → LOG_FILE, FILE_LEVEL → LOG_FILE_LEVEL).
- Added a note in the logger docstring to run
guidellm configif environment variables aren’t applied. - Created a new “Logging” section in DEVELOPING.md with the updated variable names and usage instructions.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/guidellm/logger.py | Updated env‐var names in docstring and added config validation note |
| DEVELOPING.md | Added Logging section with environment variable reference and troubleshooting |
Comments suppressed due to low confidence (2)
src/guidellm/logger.py:19
- Indent this line (and the following continuation line) to match the existing docstring indentation so it renders correctly.
If logging isn't responding to the environment variables, run the `guidellm config`
DEVELOPING.md:279
- [nitpick] Add a period at the end of this bullet to match the punctuation style of the other entries.
- `GUIDELLM__LOGGING__LOG_FILE`: Path to the log file for file logging (default: guidellm.log if log file level set else none)
DaltheCow
pushed a commit
that referenced
this pull request
Jul 15, 2025
The logging documentation is buried in a code file, and it's wrong, so this PR corrects that. --------- Signed-off-by: Jared O'Connell <[email protected]> Co-authored-by: Mark Kurtz <[email protected]>
DaltheCow
pushed a commit
that referenced
this pull request
Jul 15, 2025
The logging documentation is buried in a code file, and it's wrong, so this PR corrects that. --------- Signed-off-by: Jared O'Connell <[email protected]> Co-authored-by: Mark Kurtz <[email protected]> Signed-off-by: dalthecow <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The logging documentation is buried in a code file, and it's wrong, so this PR corrects that.