fix:Improve log warnings in REST API /health endpoint #5381
Conversation
This file contains 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
ArzelaAscoIi
approved these changes
Jul 20, 2023
There was a problem hiding this comment.
Validated against CUDA driver version 470.XX that is has the known pynvml issue described here.
Can confirm that the error is not logged 🚀 Thank you for taking care of it.
|
@ArzelaAscoIi would you please test this version? |
ArzelaAscoIi
approved these changes
Jul 24, 2023
|
@anakin87 the existing unit test related to /health checkpoint |
|
@vblagoje please go ahead and merge! |
anakin87
pushed a commit
that referenced
this pull request
Jul 26, 2023
* Improve warning in REST APIs get_health_status method * Convert log message * A better solution and documentation * Add another nested try/except block * Simplify
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.
What?
In this PR, we make an improvement to the log warning in the REST API /health endpoint. Specifically, we change the warning message from "No NVIDIA GPU found." to "Couldn't collect GPU stats: ".
Why?
The current warning message is misleading and may cause confusion among users, potentially leading to unnecessary new issues being created. By giving a more descriptive and accurate warning, we aim to provide a better user experience and minimize confusion.
How can it be used?
This change is internal and does not affect the way users interact with the REST API /health endpoint. The improvement will only affect the content of the log messages generated when a request is made to this endpoint.
How did you test it?
The testing for this change is still ongoing. Manual testing is currently being conducted to ensure the updated log warning is accurate and provides the desired clarity.
Notes for the reviewer
Do not integrate yet. This PR is issued to ease communication between the stakeholders involved.