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(web): Some tweaks in the workflow details #16706

Merged
merged 4 commits into from
Sep 8, 2024

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Sep 4, 2024

Description

Some changes to the Workflow screen:

  • For Reshard workflows: shows source/target shards in the header
  • Capitalize Keyspace: from Target keyspace to Target Keyspace
  • Make timestamps more compact to make the display denser, like. mm/dd/yy HH:MM:SS UTC. (no century, 24 hour format)
  • Add the units (seconds) to the replication lag
  • If more than 8 shards: don’t show logs for now.
  • In streams, show the source shard and target shard, and add link to tablet.
  • Remove Streams Table from the Lag Graph tab
  • Remove "Scroll To Streams" from tabs other than "Details"
  • Reduce space above the Summary caption

Related Issue(s)

Screenshots

Screenshot 2024-09-05 at 3 29 07 PM

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

Copy link
Contributor

vitess-bot bot commented Sep 4, 2024

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 Sep 4, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 4, 2024
@beingnoble03 beingnoble03 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTAdmin VTadmin interface Component: web UI 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 4, 2024
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

If you removed the Streams from the Lag tab, we can remove the Scroll To Streams link.

@beingnoble03
Copy link
Member Author

Done. Also, pushed the changes to show "Scroll To Streams" only in case of Details Tab.

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

❤️ Just a couple of minor nits/questions. VTAdmin is looking so useful now for VReplication workflows! I love it.

web/vtadmin/src/components/routes/workflow/Workflow.tsx Outdated Show resolved Hide resolved
web/vtadmin/src/components/routes/workflow/Workflow.tsx Outdated Show resolved Hide resolved
/>
</div>
))}
{streams.length <= 8 && (
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like we should have some sort of else condition here where we display something to indicate that we've elided the otherwise expected UI element / display content due to the larger number of shards?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

Screenshot 2024-09-08 at 2 31 43 PM

(PS: Used streams.length <= 1 just for the preview)

Copy link

codecov bot commented Sep 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.93%. Comparing base (d276007) to head (25a6fc7).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16706      +/-   ##
==========================================
+ Coverage   68.91%   68.93%   +0.02%     
==========================================
  Files        1565     1565              
  Lines      201605   201745     +140     
==========================================
+ Hits       138926   139067     +141     
+ Misses      62679    62678       -1     

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

@rohit-nayak-ps rohit-nayak-ps merged commit 53dbede into vitessio:main Sep 8, 2024
132 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTAdmin VTadmin interface Component: web UI 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