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

Enable verbose logging for some more RPCs #14770

Merged
merged 2 commits into from
Dec 14, 2023

Conversation

GuptaManan100
Copy link
Member

Description

Went over all the tablet manager RPCs, and specifically for some of the RPCs that are used in reparenting, it is useful to print their responses in the vttablet logs, to debug failures when they occur. Enabling verbose logging, prints a log when the said function finishes execution which can be very helpful information while debugging.

I have been careful in only enabling verbose logging for RPCs, that aren't called on a regular interval, so as to not pollute the logs.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Manan Gupta <manan@planetscale.com>
Copy link
Contributor

vitess-bot bot commented Dec 13, 2023

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 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 Dec 13, 2023
@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 Dec 13, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 13, 2023
@GuptaManan100 GuptaManan100 force-pushed the handle-panic-verbose branch 2 times, most recently from c6523a4 to 37ee9c8 Compare December 13, 2023 11:25
@harshit-gangal
Copy link
Member

unit test is failing.

3-12-13T11:58:15.1312097Z ok  	vitess.io/vitess/go/vt/vttablet/grpctabletconn	0.093s
2023-12-13T11:58:15.1312525Z === RUN   TestGRPCTMServer
2023-12-13T11:58:15.1314097Z     test_tm_rpc.go:1042: Expected a panic error with 'HandleRPCPanic caught panic during PopulateReparentJournal with verbose false' but got: rpc error: code = Unknown desc = HandleRPCPanic caught panic during PopulateReparentJournal with verbose true
2023-12-13T11:58:15.1315368Z --- FAIL: TestGRPCTMServer (0.07s)

@deepthi
Copy link
Member

deepthi commented Dec 13, 2023

unit test is failing.

3-12-13T11:58:15.1312097Z ok  	vitess.io/vitess/go/vt/vttablet/grpctabletconn	0.093s
2023-12-13T11:58:15.1312525Z === RUN   TestGRPCTMServer
2023-12-13T11:58:15.1314097Z     test_tm_rpc.go:1042: Expected a panic error with 'HandleRPCPanic caught panic during PopulateReparentJournal with verbose false' but got: rpc error: code = Unknown desc = HandleRPCPanic caught panic during PopulateReparentJournal with verbose true
2023-12-13T11:58:15.1315368Z --- FAIL: TestGRPCTMServer (0.07s)

That line in the test just needs to change to true to match the change in the rpc body.
I did notice that this unit test does not have anything for WaitForPosition. While this is a true unit test and its utility is doubtful, it may still be worth adding it in.

Just a note that this PR was motivated by the debugging needed to diagnose #14738. There was no log line for when WaitForPosition completed, and if there had been we would have seen the error from it, instead of having to infer that it had timed out from timestamps + the fact that a success log line was missing.

Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
Copy link
Member Author

As suggested, I have added a test for WaitForPosition too.

@GuptaManan100 GuptaManan100 merged commit 9d4c726 into vitessio:main Dec 14, 2023
116 checks passed
@GuptaManan100 GuptaManan100 deleted the handle-panic-verbose branch December 14, 2023 08:51
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.

3 participants