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

Add infinite buffer to health check consumers #17632

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

Conversation

GuptaManan100
Copy link
Member

Description

This PR fixes the problem described in #17629. As pointed out in the issue, the problem is that the consumers aren't fast enough to ingest all the health check updates and that causes them to miss some of them.

To prevent this, this PR adds a new message queue which keeps track of messages with an infinite capacity (we'll OOM eventually), while continuing to support the same semantics from the client side. The message queue has been added in a higher level package so that it can shared across the codebase if the use case for it arrises in the future.

Related Issue(s)

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

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Jan 27, 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 Jan 27, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 27, 2025
@GuptaManan100 GuptaManan100 force-pushed the healthcheck-buffer-size branch from 4a46293 to 9e0a835 Compare January 27, 2025 09:47
@GuptaManan100 GuptaManan100 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 labels Jan 27, 2025
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

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

Project coverage is 67.67%. Comparing base (a6c2896) to head (86ff824).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/concurrency/message_queue.go 89.47% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17632      +/-   ##
==========================================
+ Coverage   67.64%   67.67%   +0.03%     
==========================================
  Files        1586     1587       +1     
  Lines      255629   255732     +103     
==========================================
+ Hits       172910   173078     +168     
+ Misses      82719    82654      -65     

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

// Keep receiving updates on the message queue.
th, validRes := mq.Receive()
if validRes {
c <- th
Copy link
Member

Choose a reason for hiding this comment

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

This will block if channel is full, correct?

Copy link
Member

Choose a reason for hiding this comment

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

Let us add a metric that exports the size of this queue.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay 👍

totalCount := 0
go func() {
for range ch {
totalCount++
Copy link
Member

Choose a reason for hiding this comment

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

you need to put this access and the other one behind a mutex, otherwise race test fails.

@deepthi deepthi removed the NeedsBackportReason If backport labels have been applied to a PR, a justification is required label Jan 27, 2025
@deepthi
Copy link
Member

deepthi commented Jan 27, 2025

No back ports of this PR, please. Instead we can do #17634 on old release branches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: vtgate buffering times out even after receiving healthcheck from new primary
2 participants