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.

Sign up for GitHub

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

Jump to bottom

Add HealthCheck's healthy map to the VTGate UI #14521

Merged
merged 3 commits into from
Nov 16, 2023
Merged

Add HealthCheck's healthy map to the VTGate UI #14521

merged 3 commits into from
Nov 16, 2023

Conversation

frouioui
Copy link
Member

@frouioui frouioui commented Nov 15, 2023 •
edited
Loading

Description

This PR adds a new table to the health status page of the VTGate UI: the Health Check - Healthy Tablets which lists all the elements in the HealthCheck's healthy map.

This is now what it looks like:

image

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Nov 15, 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 Nov 15, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 15, 2023
@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Cluster management and 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 Nov 15, 2023
ajm188
ajm188 approved these changes Nov 15, 2023
View reviewed changes
Copy link
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

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

one minor fix but lgtm!

go/cmd/vtgate/cli/status.go
return vtg.Gateway().TabletsCacheStatus()
})
servenv.AddStatusPart("Health Check - Healthy Tablets", discovery.HealthCheckHealthyTemplate, func() any {
Copy link
Contributor

Choose a reason for hiding this comment

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

here we have "Healthy Tablets" but in the vtcombo version it is just "Healthy". i think we should be consistent between the two, but i have no preference which one you standardize on

Copy link
Member

Choose a reason for hiding this comment

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

I would even suggest dropping "Tablet" from the table headers. Hope no one is depending on the header values though :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch thank you!

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed via f6d526e

deepthi
deepthi approved these changes Nov 15, 2023
View reviewed changes
go/vt/discovery/healthcheck.go Outdated
Comment on lines 98 to 102
HealthCheckCacheTemplate = fmt.Sprintf(healthCheckTemplate, "HealthCheck Tablet - Cache")

// HealthCheckHealthyTemplate uses healthCheckTemplate with the `HealthCheck Tablet - Healthy Tablets` title to
// create the HTML code required to render the list of healthy tablets from the HealthCheck.
HealthCheckHealthyTemplate = fmt.Sprintf(healthCheckTemplate, "HealthCheck Tablet - Healthy Tablets")
Copy link
Member

Choose a reason for hiding this comment

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

Can possibly drop "Tablet", so that the headers show up as "HealthCheck - Cache" and "HealthCheck - Healthy Tablets"

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed via f6d526e

go/vt/discovery/healthcheck.go Show resolved Hide resolved
@frouioui frouioui merged commit f8066f6 into vitessio:main Nov 16, 2023
115 checks passed
@frouioui frouioui deleted the enhanced-vtgate-ui-healthcheck branch November 16, 2023 02:40
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
@frouioui @ejortegau
Add HealthCheck's healthy map to the VTGate UI (vitessio#14521)
1881925
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajm188 ajm188 ajm188 approved these changes

@deepthi deepthi deepthi approved these changes

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

Assignees
No one assigned
Labels
Component: Cluster management Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@frouioui @deepthi @ajm188