Skip to content

api: fix description for ORCA utilization precedence and document weight derivation#46002

Open
jukie wants to merge 4 commits into
envoyproxy:mainfrom
jukie:orca-proto-docs
Open

api: fix description for ORCA utilization precedence and document weight derivation#46002
jukie wants to merge 4 commits into
envoyproxy:mainfrom
jukie:orca-proto-docs

Conversation

@jukie

@jukie jukie commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Commit Message: api: fix description for ORCA utilization precedence

Additional Description:
The metric_names_for_computing_utilization field comments in client_side_weighted_round_robin/load_aware_locality still describe the legacy utilization-precedence order. After #44196, envoy.reloadable_features.orca_weight_manager_use_named_metrics_first now defaults to true so the described order and gating was incorrect. They now match the runtime-dependent behavior of the shared getUtilizationFromOrcaReport helper:

  1. max of the named metrics, used when that max is > 0
  2. else application_utilization, used when > 0
  3. else cpu_utilization

Also includes clarification about rps_fractional requirement and weight derivation.

Risk Level: Low
Testing: N/A
Docs Changes: Updated load_aware_locality docs
Release Notes: None
Platform Specific Features: N/A
API Considerations: Comment only changes

Signed-off-by: jukie <10012479+jukie@users.noreply.github.com>
@repokitteh-read-only

Copy link
Copy Markdown

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #46002 was opened by jukie.

see: more, trace.

@jukie jukie changed the title named-metrics-first ORCA utilization precedence api: correct description for ORCA utilization precedence Jul 6, 2026
@jukie jukie changed the title api: correct description for ORCA utilization precedence api: fix ORCA utilization metric precedence description Jul 6, 2026
@jukie jukie changed the title api: fix ORCA utilization metric precedence description api: fix description for ORCA utilization precedence Jul 6, 2026
@jukie jukie marked this pull request as ready for review July 6, 2026 21:08
@repokitteh-read-only

Copy link
Copy Markdown

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @markdroth
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #46002 was ready_for_review by jukie.

see: more, trace.

@jukie

jukie commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

CC @efimki for #44196

jukie added 2 commits July 8, 2026 11:40
Signed-off-by: jukie <10012479+jukie@users.noreply.github.com>
Signed-off-by: jukie <10012479+jukie@users.noreply.github.com>
@jukie

jukie commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the protobuf and RST documentation for client-side weighted round-robin (CSWRR) and load-aware locality load balancing policies to clarify how endpoint utilization is resolved from ORCA reports, including the default precedence of named metrics over application utilization. The review feedback correctly identifies an inaccuracy in the updated documentation: the code actually checks if the final utilization (resolved utilization plus any error penalty) is greater than 0, rather than just the resolved utilization itself. Actionable suggestions were provided to correct this in both the proto comments and the RST documentation.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/root/intro/arch_overview/upstream/load_balancing/load_balancers.rst Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Isaac Wilson <isaac.wilson514@gmail.com>
@jukie jukie changed the title api: fix description for ORCA utilization precedence api: fix description for ORCA utilization precedence and document weight derivation Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants