fix: Enhance error logging in BackgroundTaskManager to include exception details #4504
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
HyeockJinKim
added
the
skip:changelog
github-actions
bot
added
size:XS
There was a problem hiding this comment.
Pull Request Overview
This PR enhances error logging in the background task observer and corrects the placement of sched_dispatcher_ctx in the root app builder.
- Moves
sched_dispatcher_ctxearlier in thebuild_root_appcall, removing a duplicate and grouping dispatcher contexts. - Updates
_observe_bgtaskto log exception details when a task fails.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/ai/backend/manager/server.py | Reordered sched_dispatcher_ctx argument in build_root_app call. |
| src/ai/backend/common/bgtask/bgtask.py | Included exception variable e in the error log message. |
Comments suppressed due to low confidence (1)
src/ai/backend/common/bgtask/bgtask.py:334
- Add a test case that triggers an exception in
_observe_bgtaskto verify the log output includes the exception message (and stack trace if implemented).
log.error("Task {} ({}): unhandled error: {}", task_id, task_name, e)
| @@ -331,7 +331,7 @@ async def _observe_bgtask( | |||
| operation=ErrorOperation.EXECUTE, | |||
| error_detail=ErrorDetail.INTERNAL_ERROR, | |||
| ) | |||
| log.error("Task {} ({}): unhandled error", task_id, task_name) | |||
| log.error("Task {} ({}): unhandled error: {}", task_id, task_name, e) | |||
There was a problem hiding this comment.
Consider using log.exception or passing exc_info=True to capture the full stack trace, for example:
log.exception("Task %s (%s) failed", task_id, task_name)
Suggested change
| log.error("Task {} ({}): unhandled error: {}", task_id, task_name, e) | |
| log.exception("Task {} ({}): unhandled error: {}", task_id, task_name, e) |
Copilot uses AI. Check for mistakes.
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.
Checklist: (if applicable)
ai.backend.testdocsdirectory