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

[Bugfix][Core] Fix and refactor logging stats #4336

Merged
merged 12 commits into from
May 1, 2024

Conversation

esmeetu
Copy link
Collaborator

@esmeetu esmeetu commented Apr 24, 2024

Currently engine stats log will output 0 when using --engine-use-ray.
And this PR compact logging stats code by using existed function.

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
Collaborator

@rkooo567 rkooo567 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Wonder if we can add an unit test for this inside

def test_api_server(api_server, tokenizer_pool_size: int, worker_use_ray: bool,
? Basically just capture the stdout and verify it is printed

@esmeetu
Copy link
Collaborator Author

esmeetu commented Apr 27, 2024

@rkooo567 I use capsys to capture the server output:captured = capsys.readouterr(), but it always output empty, do you know why?🤔

@rkooo567
Copy link
Collaborator

Hmm when you don't use capsys and run the test, does it print the server logs?

probably because api server is running in a subprocess, and their stdout/stderr is not printed. I think you can use https://docs.python.org/3/library/subprocess.html#subprocess.Popen.communicate to get stdout/stderr (in this case, you may not even need capsys)

@esmeetu
Copy link
Collaborator Author

esmeetu commented Apr 27, 2024

@rkooo567 It will print log when i add args -s.
My last version is using [Popen.communicate]:

    with subprocess.Popen(commands,
                          stdout=subprocess.PIPE,
                          stderr=subprocess.STDOUT) as uvicorn_process:
        output, _ = uvicorn_process.communicate()
        output = output.decode(locale.getpreferredencoding())
        assert "prompt" in output
        yield

But this will block test. 🫠

@rkooo567
Copy link
Collaborator

In [13]: def f():
    ...:     from subprocess import TimeoutExpired
    ...:     proc = subprocess.Popen(["python", "a.py"])
    ...:     try:
    ...:         outs, errs = proc.communicate(timeout=3)
    ...:     except TimeoutExpired:
    ...:         proc.kill()
    ...:         outs, errs = proc.communicate()
    ...:         print(outs)
    ...:         print(errs)

I think you can make this way to terminate the subprocess?

@esmeetu
Copy link
Collaborator Author

esmeetu commented Apr 27, 2024

@rkooo567 Thanks for you help. But My local test is ok while not in our CI. ☹️

@rkooo567
Copy link
Collaborator

Is it okay if I try something on this PR directly?

@esmeetu
Copy link
Collaborator Author

esmeetu commented Apr 28, 2024

Is it okay if I try something on this PR directly?

No problem.

@rkooo567 rkooo567 self-assigned this Apr 28, 2024
@rkooo567
Copy link
Collaborator

rkooo567 commented May 1, 2024

I took a look. I feel like we are hitting https://www.reddit.com/r/Python/comments/1vbie0/subprocesspipe_will_hang_indefinitely_if_stdout/.

I worked around it by redirecting logs to tempfile. This will hinder debuggability, so I added logs to explain how to debug.

See this PR rkooo567#25. or if you give me persmission to your repo, I can push there directly (it seems like it is not allowed)

@esmeetu
Copy link
Collaborator Author

esmeetu commented May 1, 2024

@rkooo567 I revert test changes in this PR, can we merge this first and then submit your changes in another PR?

@rkooo567
Copy link
Collaborator

rkooo567 commented May 1, 2024

yeah that sgtm!

@rkooo567
Copy link
Collaborator

rkooo567 commented May 1, 2024

cc @cadedaniel to merge

@cadedaniel
Copy link
Collaborator

Thanks guys -- can we get testing in your PR @rkooo567 ?

@cadedaniel
Copy link
Collaborator

I am retrying the basic correctness test -- seems it failed for an infra error

@cadedaniel cadedaniel enabled auto-merge (squash) May 1, 2024 19:33
@cadedaniel cadedaniel merged commit 3a922c1 into vllm-project:main May 1, 2024
48 checks passed
@esmeetu esmeetu deleted the fix-log branch May 2, 2024 01:59
robertgshaw2-neuralmagic pushed a commit to neuralmagic/nm-vllm that referenced this pull request May 6, 2024
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request May 7, 2024
dtrifiro pushed a commit to opendatahub-io/vllm that referenced this pull request May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants