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

[vtadmin] log response errors #12844

Merged

Conversation

ajm188
Copy link
Contributor

@ajm188 ajm188 commented Apr 5, 2023

Description

This installs middleware ("ish" in the case of the http side) layers to both the HTTP and gRPC APIs for vtadmin to ensure that any methods that ultimately return an error log that error at the ERROR level to facilitate better debugging

Testing

After creating a bogus shard as described in #12842, trying to load the keyspace page now shows in the logs as:

E0405 14:32:48.115084   20808 response.go:48] FindAllShardsInKeyspace(cluster = local, keyspace = commerce) failed: rpc error: code = Unknown desc = uncaught panic: runtime error: invalid memory address or nil pointer dereference
E0405 14:32:49.139644   20808 response.go:48] FindAllShardsInKeyspace(cluster = local, keyspace = commerce) failed: rpc error: code = Unknown desc = uncaught panic: runtime error: invalid memory address or nil pointer dereference
E0405 14:32:50.023643   20808 response.go:48] FindAllShardsInKeyspace(cluster = local, keyspace = commerce) failed: rpc error: code = Unknown desc = uncaught panic: runtime error: invalid memory address or nil pointer dereference

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

Andrew Mason added 2 commits April 5, 2023 14:33
Signed-off-by: Andrew Mason <andrew@planetscale.com>
Signed-off-by: Andrew Mason <andrew@planetscale.com>
@ajm188 ajm188 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTAdmin VTadmin interface Component: Observability Pull requests that touch tracing/metrics/monitoring labels Apr 5, 2023
@ajm188 ajm188 added this to the v17.0.0 milestone Apr 5, 2023
@ajm188 ajm188 requested a review from deepthi April 5, 2023 18:44
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 5, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 5, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

Copy link
Contributor

@notfelineit notfelineit left a comment

Choose a reason for hiding this comment

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

This is nice!

@deepthi deepthi removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 5, 2023
@ajm188 ajm188 merged commit 8137d92 into vitessio:main Apr 5, 2023
@ajm188 ajm188 deleted the andrew/vtadmin/log-response-errors branch April 5, 2023 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Observability Pull requests that touch tracing/metrics/monitoring Component: VTAdmin VTadmin interface 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