Skip to content

Conversation

@tedzhouhk
Copy link
Contributor

@tedzhouhk tedzhouhk commented Jun 12, 2025

remove LLMMetricAnnotation from response stream to unblock GAP

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of LLM metric annotations to prevent certain internal metrics from appearing in the event stream.

@copy-pr-bot
Copy link

copy-pr-bot bot commented Jun 12, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@ishandhanani
Copy link
Contributor

Will run GAP benchmarks and then approve

Signed-off-by: Hongkuan Zhou <tedzhouhk@gmail.com>
@ajcasagrande
Copy link
Contributor

warning: variable does not need to be mutable
   --> lib/llm/src/http/service/openai.rs:499:5
    |
499 |     mut annotated: EventConverter<T>,
    |     ----^^^^^^^^^
    |     |
    |     help: remove this `mut`
    |
    = note: `#[warn(unused_mut)]` on by default

Signed-off-by: Hongkuan Zhou <tedzhouhk@gmail.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

Walkthrough

The function process_event_converter in the OpenAI HTTP service was updated to allow mutation of the annotated variable. After updating response metrics, the function now clears specific fields in annotated under certain conditions to prevent metric annotations from appearing in the SSE event stream. No public interfaces were changed.

Changes

File Change Summary
lib/llm/src/http/service/openai.rs Made annotated mutable in process_event_converter; conditionally clears fields to filter SSE output

Poem

A hop and a skip, a code tweak anew,
Metrics now hidden, SSE streams true.
Annotated fields, cleared with care,
Only the right events make it out there.
In the warren of bytes, the rabbits delight—
Clean streams for all, by day or by night! 🐇


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
lib/llm/src/http/service/openai.rs (1)

509-514: Ensure data is also cleared when redacting

If you choose to keep the “blank-out” approach instead of early-returning, make sure you
remove any payload that might sit in annotated.data; otherwise the raw metric annotation
could still leak to the client.

             annotated.event = None;
             annotated.comment = None;
+            annotated.data = None;   // prevent accidental leakage
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb71be9 and f6d6178.

📒 Files selected for processing (1)
  • lib/llm/src/http/service/openai.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: pre-merge-rust (lib/bindings/python)
  • GitHub Check: pre-merge-rust (lib/runtime/examples)
  • GitHub Check: pre-merge-rust (.)
  • GitHub Check: Build and Test - vllm

@tedzhouhk tedzhouhk merged commit b051a21 into main Jun 13, 2025
11 checks passed
@tedzhouhk tedzhouhk deleted the hzhou/annotation_fix branch June 13, 2025 15:43
@coderabbitai coderabbitai bot mentioned this pull request Jun 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants