Skip to content
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

Merged
merged 4 commits into from
Aug 20, 2024

Conversation

ronensc
Copy link
Contributor

@ronensc ronensc commented Aug 7, 2024

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:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to 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:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an 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.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

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!

Copy link

github-actions bot commented Aug 7, 2024

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

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:

  • Comment /ready on the PR
  • Add ready label to the PR
  • Enable auto-merge.

🚀

vllm/tracing.py Outdated
Comment on lines 24 to 25
except ImportError as e:
otel_import_err = e
Copy link
Collaborator

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.

Copy link
Collaborator

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?

Copy link
Contributor Author

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:

  1. Clear the traceback of the exception

    except ImportError as e:
        # Clear traceback to avoid memory leak
        e.__traceback__ = None
        otel_import_err = e
    
  2. 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 of raise 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?

Copy link
Collaborator

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

Copy link
Contributor Author

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.

@simon-mo simon-mo enabled auto-merge (squash) August 20, 2024 15:03
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 20, 2024
@youkaichao youkaichao merged commit 2aa00d5 into vllm-project:main Aug 20, 2024
75 of 77 checks passed
@ronensc ronensc changed the title [CI/Build] Pin OpenTelemetry versions and make a availability errors clearer [CI/Build] Pin OpenTelemetry versions and make availability errors clearer Aug 20, 2024
zifeitong pushed a commit to zifeitong/vllm that referenced this pull request Aug 20, 2024
…roject#7266)

[CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266)
@ronensc ronensc deleted the otel-pin-versions branch August 21, 2024 07:15
omrishiv pushed a commit to omrishiv/vllm that referenced this pull request Aug 26, 2024
…roject#7266)

[CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266)
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
…roject#7266)

[CI/Build] Pin OpenTelemetry versions and make a availability errors clearer (vllm-project#7266)

Signed-off-by: Alvant <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants