-
Notifications
You must be signed in to change notification settings - Fork 255
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
Make stream include usage as optional #788
Merged
varungup90
merged 2 commits into
vllm-project:main
from
varungup90:stream-usage-optional
Mar 4, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| /* | ||
| Copyright 2024 The Aibrix Team. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package gateway | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "slices" | ||
| "strings" | ||
|
|
||
| configPb "github.com/envoyproxy/go-control-plane/envoy/config/core/v3" | ||
| extProcPb "github.com/envoyproxy/go-control-plane/envoy/service/ext_proc/v3" | ||
| envoyTypePb "github.com/envoyproxy/go-control-plane/envoy/type/v3" | ||
| "github.com/vllm-project/aibrix/pkg/utils" | ||
| "k8s.io/klog/v2" | ||
| ) | ||
|
|
||
| // validateStreamOptions validates whether stream options to include usage is set for user request | ||
| func validateStreamOptions(requestID string, user utils.User, jsonMap map[string]interface{}) *extProcPb.ProcessingResponse { | ||
| if user.Tpm != 0 { | ||
| streamOptions, ok := jsonMap["stream_options"].(map[string]interface{}) | ||
| if !ok { | ||
| klog.ErrorS(nil, "no stream option available", "requestID", requestID, "jsonMap", jsonMap) | ||
| return generateErrorResponse(envoyTypePb.StatusCode_InternalServerError, | ||
| []*configPb.HeaderValueOption{{Header: &configPb.HeaderValue{ | ||
| Key: HeaderErrorNoStreamOptions, RawValue: []byte("stream options not set")}}}, | ||
| "no stream option available") | ||
| } | ||
| includeUsage, ok := streamOptions["include_usage"].(bool) | ||
| if !includeUsage || !ok { | ||
| klog.ErrorS(nil, "no stream with usage option available", "requestID", requestID, "jsonMap", jsonMap) | ||
| return generateErrorResponse(envoyTypePb.StatusCode_InternalServerError, | ||
| []*configPb.HeaderValueOption{{Header: &configPb.HeaderValue{ | ||
| Key: HeaderErrorStreamOptionsIncludeUsage, RawValue: []byte("include usage for stream options not set")}}}, | ||
| "no stream with usage option available") | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // getRoutingStrategy retrieves the routing strategy from the headers or environment variable | ||
| // It returns the routing strategy value and whether custom routing strategy is enabled. | ||
| func getRoutingStrategy(headers []*configPb.HeaderValue) (string, bool) { | ||
varungup90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| var routingStrategy string | ||
| routingStrategyEnabled := false | ||
|
|
||
| // Check headers for routing strategy | ||
| for _, header := range headers { | ||
| if strings.ToLower(header.Key) == HeaderRoutingStrategy { | ||
| routingStrategy = string(header.RawValue) | ||
| routingStrategyEnabled = true | ||
| break // Prioritize header value over environment variable | ||
| } | ||
| } | ||
|
|
||
| // If header not set, check environment variable | ||
| if !routingStrategyEnabled { | ||
| if value, exists := utils.CheckEnvExists(EnvRoutingAlgorithm); exists { | ||
| routingStrategy = value | ||
| routingStrategyEnabled = true | ||
| } | ||
| } | ||
|
|
||
| return routingStrategy, routingStrategyEnabled | ||
| } | ||
|
|
||
| // validateRoutingStrategy validates if user provided routing strategy is supported by gateway | ||
| func validateRoutingStrategy(routingStrategy string) bool { | ||
| routingStrategy = strings.TrimSpace(routingStrategy) | ||
| return slices.Contains(routingStrategies, routingStrategy) | ||
| } | ||
|
|
||
| // getRequestMessage returns input request message field which has user prompt | ||
| func getRequestMessage(jsonMap map[string]interface{}) (string, *extProcPb.ProcessingResponse) { | ||
| messages, ok := jsonMap["messages"] | ||
| if !ok { | ||
| return "", generateErrorResponse(envoyTypePb.StatusCode_InternalServerError, | ||
| []*configPb.HeaderValueOption{{Header: &configPb.HeaderValue{Key: HeaderErrorRequestBodyProcessing, RawValue: []byte("true")}}}, | ||
| "no messages in the request body") | ||
| } | ||
| messagesJSON, err := json.Marshal(messages) | ||
| if err != nil { | ||
| return "", generateErrorResponse(envoyTypePb.StatusCode_InternalServerError, | ||
| []*configPb.HeaderValueOption{{Header: &configPb.HeaderValue{Key: HeaderErrorRequestBodyProcessing, RawValue: []byte("true")}}}, | ||
| "unable to marshal messages from request body") | ||
| } | ||
| return string(messagesJSON), nil | ||
| } | ||
|
|
||
| // generateErrorResponse construct envoy proxy error response | ||
| func generateErrorResponse(statusCode envoyTypePb.StatusCode, headers []*configPb.HeaderValueOption, body string) *extProcPb.ProcessingResponse { | ||
| // Set the Content-Type header to application/json | ||
| headers = append(headers, &configPb.HeaderValueOption{ | ||
| Header: &configPb.HeaderValue{ | ||
| Key: "Content-Type", | ||
| Value: "application/json", | ||
| }, | ||
| }) | ||
|
|
||
| return &extProcPb.ProcessingResponse{ | ||
| Response: &extProcPb.ProcessingResponse_ImmediateResponse{ | ||
| ImmediateResponse: &extProcPb.ImmediateResponse{ | ||
| Status: &envoyTypePb.HttpStatus{ | ||
| Code: statusCode, | ||
| }, | ||
| Headers: &extProcPb.HeaderMutation{ | ||
| SetHeaders: headers, | ||
| }, | ||
| Body: generateErrorMessage(body, int(statusCode)), | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // generateErrorMessage constructs a JSON error message | ||
| func generateErrorMessage(message string, code int) string { | ||
| errorStruct := map[string]interface{}{ | ||
| "error": map[string]interface{}{ | ||
| "message": message, | ||
| "code": code, | ||
| }, | ||
| } | ||
| jsonData, _ := json.Marshal(errorStruct) | ||
| return string(jsonData) | ||
| } | ||
Oops, something went wrong.
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.
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.
How can we know user are using heterogenous features? If we have the feature flag, we can do some validation here as well. not something we need to fix in this PR, just surface this requirement
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 am thinking we should have a feature flag for heterogenous feature. Right now it is enabled by default and incurs some performance penalty.
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.
yeah, please help document this issue.