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

Store the health check subscriber name to improve error message #17863

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

Conversation

GuptaManan100
Copy link
Member

Description

This PR changes the health check to also keep track of the subscriber name so that the information message printed when we drop some healthcheck updates due to a full buffer are more informative. We also print out the stack trace once when we drop the update.

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 Feb 25, 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 25, 2025
@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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 25, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 25, 2025
Signed-off-by: Manan Gupta <[email protected]>
Copy link

codecov bot commented Feb 25, 2025

Codecov Report

Attention: Patch coverage is 41.17647% with 10 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (82d21e5) to head (406260d).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/discovery/healthcheck.go 36.36% 7 Missing ⚠️
go/vt/vtgate/vtgate.go 0.00% 2 Missing ⚠️
go/vt/throttler/demo/throttler_demo.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17863      +/-   ##
==========================================
- Coverage   67.46%   67.44%   -0.02%     
==========================================
  Files        1593     1594       +1     
  Lines      258902   259070     +168     
==========================================
+ Hits       174658   174739      +81     
- Misses      84244    84331      +87     

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

Comment on lines +651 to +655
var printStack = sync.OnceFunc(func() {
buf := make([]byte, 10240) // Allocate buffer large enough
n := runtime.Stack(buf, true)
fmt.Printf("All Goroutines Stack Trace:\n%s\n", buf[:n])
})
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this happen only for debugging?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, we want to merge this, so that if we exhaust the pool in production we have the stack trace in the logs. This is why its behind a sync.Once call so that we print that only once.

Copy link
Member

Choose a reason for hiding this comment

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

Could you please help me understand why it is needed to print all go routines stack trace?
What information will use be used from it?

Copy link
Member Author

Choose a reason for hiding this comment

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

We can see why the subscriber is blocked and not processing the updates, because we'll be able to see their stack trace.

Copy link
Member

Choose a reason for hiding this comment

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

If this is the reason, we can use the pprof to output the logs with

pprof.Lookup("goroutine").WriteTo(os.Stdout, 1)

runtime.Stack(buf, true) with true could do a stop the world to inspect all goroutines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTGate 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