-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CI/Build] Pin OpenTelemetry versions and make availability errors clearer #7266
Conversation
👋 Hi! Thank you for contributing to the vLLM project. Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge). To run full CI, you can do one of these:
🚀 |
vllm/tracing.py
Outdated
except ImportError as e: | ||
otel_import_err = e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously when we store the error as a variable, it cause memory leak because it will save everything on the slack including the caller's, so anything defined globally cannot be cleaned up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove this or find another way?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, I see. I suggest the following alternatives:
-
Clear the traceback of the exception
except ImportError as e: # Clear traceback to avoid memory leak e.__traceback__ = None otel_import_err = e
-
Store the string representation of the error (including the traceback)
except ImportError as e: otel_import_err = traceback.format_exc()
and include it in the
ValueError
instead ofraise from
:if not is_otel_available(): raise ValueError( f"OpenTelemetry is not... Original error:\n{otel_import_err}" )
Would either of these alternatives resolve the issue?
For reference, I noticed a similar approach is used in ray_utils.py
. Should that be reconsidered as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either works for me! See this PR as something I mentioned about the leak #2882
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opted for option 2 as it includes traceback details, which option 1 does not.
I came across a blog post discussing leaks in Python exceptions: Exception leaks in Python 2 and 3
It suggests using traceback.clear_frames()
to mitigate such leaks. However, I decided against this approach because it doesn't clear the local variables of the currently executing frame, as noted in the docs.
577c8e7
to
66f5499
Compare
…roject#7266) [CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266)
…roject#7266) [CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266)
…roject#7266) [CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266) Signed-off-by: Alvant <[email protected]>
This PR pins the major and minor versions of the OpenTelemetry packages to avoid potential issues with version mismatches.
Additionally, it enhances the clarity of OTel availability error messages.
These changes aim to mitigate issues like #7064, improving the stability and debuggability of the build process.
BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE
PR Checklist (Click to Expand)
Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.
PR Title and Classification
Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:
[Bugfix]
for bug fixes.[CI/Build]
for build or continuous integration improvements.[Doc]
for documentation fixes and improvements.[Model]
for adding a new model or improving an existing model. Model name should appear in the title.[Frontend]
For changes on the vLLM frontend (e.g., OpenAI API server,LLM
class, etc.)[Kernel]
for changes affecting CUDA kernels or other compute kernels.[Core]
for changes in the core vLLM logic (e.g.,LLMEngine
,AsyncLLMEngine
,Scheduler
, etc.)[Hardware][Vendor]
for hardware-specific changes. Vendor name should appear in the prefix (e.g.,[Hardware][AMD]
).[Misc]
for PRs that do not fit the above categories. Please use this sparingly.Note: If the PR spans more than one category, please include all relevant prefixes.
Code Quality
The PR need to meet the following code quality standards:
format.sh
to format your code.docs/source/
if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.Notes for Large Changes
Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with
rfc-required
and might not go through the PR.What to Expect for the Reviews
The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:
action-required
label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.Thank You
Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!