Skip to content
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

VReplication: Disable /debug/vrlog by default #17832

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Feb 20, 2025

Description

The /debug/vrlog tablet HTTP endpoint was added in #5889.

That was very helpful in the early development of VReplication. It can still be useful today but its use is quite rare (note that it's not documented today either).

Given that the production of this log is not lightweight, we should disable it by default. That's what this PR does, while adding a flag to enable it for the rare cases that it's wanted. I'll also document the web endpoint along with the new flag.

Related Issue(s)

Checklist

Copy link
Contributor

vitess-bot bot commented Feb 20, 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 Feb 20, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 20, 2025
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsIssue A linked issue is missing for this Pull Request labels Feb 20, 2025
Signed-off-by: Matt Lord <[email protected]>
Copy link

codecov bot commented Feb 20, 2025

Codecov Report

Attention: Patch coverage is 94.28571% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.45%. Comparing base (2118bc3) to head (2d99400).

Files with missing lines Patch % Lines
.../vt/vttablet/tabletmanager/vreplication/vplayer.go 92.30% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17832   +/-   ##
=======================================
  Coverage   67.45%   67.45%           
=======================================
  Files        1592     1592           
  Lines      258167   258189   +22     
=======================================
+ Hits       174143   174172   +29     
+ Misses      84024    84017    -7     

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

@mattlord mattlord marked this pull request as ready for review February 20, 2025 15:47
@mattlord mattlord removed the NeedsWebsiteDocsUpdate What it says label Feb 20, 2025
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

3 participants