Skip to content

Conversation

@siddharth16396
Copy link
Contributor

Description

This PR introduces option for having a "Dry Run Mode" in the Query Throttler system for Vitess tablets outlined in RFC #18412 , First PR :#18449
In this PR we are Implements a dry-run mode for the Query Throttler that allows observing throttling decisions without actually blocking queries.

Background:

  • Query throttling is critical for database performance but can be risky when first deployed
  • Operators need visibility into throttling behavior before enabling actual query blocking
  • Testing throttling logic in production environments requires non-disruptive monitoring

Solution:

  • Add DryRun boolean field to Config struct for controlling dry-runbehavior
  • When dry-run is enabled, throttling decisions are logged as warnings but queries proceed normally
  • Maintains full compatibility with existing throttling logic and strategies
  • Added comprehensive test coverage for all dry-run scenarios including disabled throttler, normal mode, and dry-run mode combinations.

Test Plan:

  • Added unit tests covering all dry-run mode scenarios in TestIncomingQueryThrottler_DryRunMode
  • Tests verify proper logging behavior and query execution flow
  • Existing query throttler tests continue to pass ensuring no regression

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

Summary:
Implements a dry-run mode for the Query Throttler that allows observing throttling decisions without actually blocking queries.
Background:
	- Query throttling is critical for database performance but can be risky when first deployed
	- Operators need visibility into throttling behavior before enabling actual query blocking
	- Testing throttling logic in production environments requires non-disruptive monitoring
Solution:
	- Add DryRun boolean field to Config struct for controlling dry-runbehavior
	- When dry-run is enabled, throttling decisions are logged as warnings but queries proceed normally
	- Maintains full compatibility with existing throttling logic and strategies
	- Added comprehensive test coverage for all dry-run scenarios including disabled throttler, normal mode, and dry-run mode combinations
Test Plan:
	- Added unit tests covering all dry-run mode scenarios in TestIncomingQueryThrottler_DryRunMode
	- Tests verify proper logging behavior and query execution flow
	- Existing query throttler tests continue to pass ensuring no regression

Signed-off-by: siddharth16396 <[email protected]>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 16, 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 Sep 16, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Sep 16, 2025
@codecov
Copy link

codecov bot commented Sep 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.53%. Comparing base (c024fff) to head (c58db58).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18657      +/-   ##
==========================================
- Coverage   67.53%   67.53%   -0.01%     
==========================================
  Files        1613     1613              
  Lines      263780   263784       +4     
==========================================
- Hits       178144   178141       -3     
- Misses      85636    85643       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: siddharth16396 <[email protected]>

// If dry-run mode is enabled, log the decision but don't throttle
if qt.cfg.DryRun {
log.Warningf("[DRY-RUN] %s", decision.Message)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We will soon be adding support for "metrics" in throttler, where we will be emitting a metric for this as well.
But that is expected later on.

@harshit-gangal harshit-gangal added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Throttler 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 Sep 19, 2025
@arthurschreiber arthurschreiber merged commit 37b337d into vitessio:main Sep 22, 2025
108 of 113 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Throttler 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