Skip to content

Planner: Add comprehensive debug logging for query planner NoRewrite cases#18476

Merged
systay merged 3 commits intovitessio:mainfrom
planetscale:debug-operator
Jul 23, 2025
Merged

Planner: Add comprehensive debug logging for query planner NoRewrite cases#18476
systay merged 3 commits intovitessio:mainfrom
planetscale:debug-operator

Conversation

@systay
Copy link
Collaborator

@systay systay commented Jul 23, 2025

Description

This PR adds detailed debug logging throughout the Vitess query planner to explain why specific optimizations are not performed when DebugOperatorTree = true. Previously, developers only saw that rewrites failed without understanding the specific reasons.

The implementation adds a debugNoRewrite() helper function and comprehensive logging to 50+ NoRewrite cases across key planner functions including horizon push/expand, limit optimization, ordering, filtering, distinct operations, and join merging. Each debug message provides specific context about blocking conditions such as phase restrictions, dependency mismatches, routing incompatibilities, or structural limitations.

This greatly improves the debugging experience for query plan optimization, making it much easier to understand why certain optimizations fail and how to address performance issues in distributed queries.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

systay added 3 commits July 23, 2025 08:22
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
Signed-off-by: Andres Taylor <andres@planetscale.com>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Jul 23, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jul 23, 2025
@systay systay added Component: Query Serving and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Jul 23, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Jul 23, 2025
@systay systay added the Type: Enhancement Logical improvement (somewhere between a bug and feature) label Jul 23, 2025
Copy link
Member

@arthurschreiber arthurschreiber left a comment

Choose a reason for hiding this comment

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

❤️

@systay systay enabled auto-merge (squash) July 23, 2025 07:23
@systay systay merged commit b9e2ed7 into vitessio:main Jul 23, 2025
101 of 118 checks passed
@systay systay deleted the debug-operator branch July 23, 2025 07:48
morgo added a commit to morgo/vitess that referenced this pull request Jul 29, 2025
…rds-new2

* origin/master:
  Set up better dependency checks (vitessio#18508)
  bugfix: Plan group by only on top of derived tables correctly (vitessio#18505)
  Fix regression in v22 around new flag setup (vitessio#18507)
  Bump form-data from 4.0.1 to 4.0.4 in /web/vtadmin (vitessio#18473)
  Bump @babel/runtime from 7.26.0 to 7.27.6 in /web/vtadmin (vitessio#18467)
  Bump vite from 4.5.9 to 4.5.14 in /web/vtadmin (vitessio#18485)
  Fix for simple projection showing no fields (vitessio#18489)
  log.Info -> log.Infof in tabletserver for reloading ACLs (vitessio#18461)
  Fix scalar aggregation with literals in empty result sets (vitessio#18477)
  Avoid terminating atomic copy workflows on error if they are out of copy phase (vitessio#18475)
  Update runners to use cncf oracle vms (vitessio#18425)
  fix: handle aliases in UNIONs better (vitessio#18484)
  VReplication: Fix bug while reading _vt.vreplication record (vitessio#18478)
  Planner: Add comprehensive debug logging for query planner NoRewrite cases (vitessio#18476)
  Update email in Maintainers file (vitessio#18472)
  tablet manager's `ExecuteFetchAsDba` does not allow multiple queries (vitessio#18183)

Signed-off-by: Morgan Tocker <tocker@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants