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

release-22.2: ui: reduce frequent Metrics page re-rendering #89103

Merged
merged 1 commit into from
Oct 7, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Sep 30, 2022

Backport 1/1 commits from #88707 on behalf of @koorosh.

/cc @cockroachdb/release


Before, many components on Metrics page relied on
nodesSummarySelector selector that in turn relies on NodeStatus that change constantly with every request (and we request it periodically every 10 seconds). NodeStatus include lots of unnecessary data for Metrics page (ie. node's and stores last metrics that aren't used on charts) but these changes forces react components to be re-rendered.

This patch refactors selectors that are used by metrics page in a way to provide only relevant subset of NodeStatus's info
to Graph components and reduce propagation of props passing from parent to child components. Instead, use selectors
in child components if necessary.

Release note: None

Release justification: low risk, high benefit changes to existing functionality

Resolves #65030

Video that shows how often components were re-rendered before this fix - regardless of timewindow, it always
updates every 10 seconds:

metrics_page_refreshes_before_fix.mov

and here's after fix. Components re-render every 10 second for 10 minutes interval and it is not re-rendered
for timewindows like 2 weeks or 1 month:

metrics_page_refreshes_after_fix.mov

Release justification:

@blathers-crl
Copy link
Author

blathers-crl bot commented Sep 30, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-22.2-88707 branch from 0707b17 to 296e408 Compare September 30, 2022 17:33
@blathers-crl blathers-crl bot requested review from koorosh, Santamaura and a team September 30, 2022 17:33
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Sep 30, 2022
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Before, many components on Metrics page relied on
`nodesSummarySelector` selector that in turn relies on `NodeStatus`
that change constantly with every request (and we request it periodically
every 10 seconds). `NodeStatus` include lots of unnecessary data for
Metrics page (ie. node's and stores last metrics that aren't used on charts)
but these changes forces react components to be re-rendered.

This patch refactors selectors that are used by metrics page in a way to
provide only relevant subset of NodeStatus's info to Graph components
and reduce propagation of props passing from parent to child components.
Instead, use selectors in child components if necessary.

Release note: None
@koorosh koorosh force-pushed the blathers/backport-release-22.2-88707 branch from 296e408 to 62cc47b Compare October 3, 2022 19:49
Copy link
Contributor

@Santamaura Santamaura left a comment

Choose a reason for hiding this comment

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

:lgtm: once CI passes

Reviewed 18 of 18 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @koorosh)

@koorosh koorosh merged commit 4007484 into release-22.2 Oct 7, 2022
@koorosh koorosh deleted the blathers/backport-release-22.2-88707 branch October 7, 2022 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants