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

ui: Add tooltips to Time Series on the Replication dashboard #26328

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
6 participants
@piyush-singh

piyush-singh commented Jun 1, 2018

Release note: Added tooltips for descriptions of time series graphs in Replication Dashboard.

Fixes #17670

@piyush-singh piyush-singh requested a review from cockroachdb/admin-ui-prs as a code owner Jun 1, 2018

@cockroach-teamcity

This comment has been minimized.

Show comment
Hide comment
@cockroach-teamcity

cockroach-teamcity Jun 1, 2018

Member

This change is Reviewable

Member

cockroach-teamcity commented Jun 1, 2018

This change is Reviewable

@CLAassistant

This comment has been minimized.

Show comment
Hide comment
@CLAassistant

CLAassistant Jun 1, 2018

CLA assistant check
All committers have signed the CLA.

CLAassistant commented Jun 1, 2018

CLA assistant check
All committers have signed the CLA.

@piyush-singh piyush-singh requested a review from Amruta-Ranade Jun 1, 2018

@vilterp

vilterp approved these changes Jun 1, 2018

@piyush-singh

This comment has been minimized.

Show comment
Hide comment
@piyush-singh

piyush-singh Jun 4, 2018

@couchand updated commit message and addressed all feedback, if it looks good, let me know and I can grab feedback from @Amruta-Ranade

piyush-singh commented Jun 4, 2018

@couchand updated commit message and addressed all feedback, if it looks good, let me know and I can grab feedback from @Amruta-Ranade

ui: Add tooltips to Time Series on the Replication dashboard
Fixes: #17670
Release note (admin ui change): Added tooltips for descriptions of time
series graphs in Replication Dashboard.
@piyush-singh

This comment has been minimized.

Show comment
Hide comment
@piyush-singh

piyush-singh commented Jun 26, 2018

@couchand and @Amruta-Ranade for a final pass

<Axis label="replicas">
<Metric name="cr.store.replicas" title="Replicas" />
<Metric name="cr.store.replicas.quiescent" title="Quiescent" />
</Axis>
</LineGraph>,
<LineGraph title="Range Operations" sources={storeSources}>
<LineGraph title="Range Operations" sources={storeSources}
tooltip = {`Ranges with split, add, or remove operations ${tooltipSelection}.`}

This comment has been minimized.

@couchand

couchand Jun 27, 2018

Member

I think this is counting the number of operations, not the number of ranges with those operations. For the most part it would be the same, but not always. For instance, if a range is split twice, we expect it to be counted twice here.

also please no spaces around the =. surprised that our linter didn't complain about this, but i think the jsx checking is kind of lax.

@couchand

couchand Jun 27, 2018

Member

I think this is counting the number of operations, not the number of ranges with those operations. For the most part it would be the same, but not always. For instance, if a range is split twice, we expect it to be counted twice here.

also please no spaces around the =. surprised that our linter didn't complain about this, but i think the jsx checking is kind of lax.

sources={storeSources}
tooltip={(
<div>
Snapshots {tooltipSelection} <br/>

This comment has been minimized.

@couchand

couchand Jun 27, 2018

Member

This summary could use two or three more words

@couchand

couchand Jun 27, 2018

Member

This summary could use two or three more words

tooltip={(
<div>
Snapshots {tooltipSelection} <br/>
When a node is far behind the log file for a range, the cluster can

This comment has been minimized.

@couchand

couchand Jun 27, 2018

Member

"log file" is not correct here, rather "raft log".

@couchand

couchand Jun 27, 2018

Member

"log file" is not correct here, rather "raft log".

<dt>Applied (Preemptive)</dt>
<dd>Snapshots applied {tooltipSelection} per second that were anticipated ahead of time</dd>
<dt>Reserved</dt>
<dd>Slots {tooltipSelection} reserved per second for incoming snapshots that will be sent to a node</dd>

This comment has been minimized.

@couchand

couchand Jun 27, 2018

Member

the end of this description reads a little awkward after tooltipSelection has been replaced

@couchand

couchand Jun 27, 2018

Member

the end of this description reads a little awkward after tooltipSelection has been replaced

@Amruta-Ranade

This comment has been minimized.

Show comment
Hide comment
@Amruta-Ranade

Amruta-Ranade Jul 11, 2018

Contributor

@piyush-singh I need your help to parse the tooltips. Can we schedule a quick session to walk through the PR?

Contributor

Amruta-Ranade commented Jul 11, 2018

@piyush-singh I need your help to parse the tooltips. Can we schedule a quick session to walk through the PR?

@piyush-singh

This comment has been minimized.

Show comment
Hide comment
@piyush-singh

piyush-singh Jul 17, 2018

@Amruta-Ranade any time this week works for me!

piyush-singh commented Jul 17, 2018

@Amruta-Ranade any time this week works for me!

<div>
Number of replicas and quiesced replicas {tooltipSelection}.
<br/>
Quiesced replicas have no pending reads or writes and have temporarily disabled consensus protocols.

This comment has been minimized.

@piyush-singh

piyush-singh Jul 23, 2018

from @Amruta-Ranade : We should make this clearer to the user, specifically what action needs to be taken when this number is high or low.

@piyush-singh

piyush-singh Jul 23, 2018

from @Amruta-Ranade : We should make this clearer to the user, specifically what action needs to be taken when this number is high or low.

<div>
Snapshots {tooltipSelection} <br/>
When a node is far behind the log file for a range, the cluster can
send it a snapshot of the range and it can start following the log from there.

This comment has been minimized.

@piyush-singh

piyush-singh Jul 23, 2018

from @Amruta-Ranade : this needs to be simplified to make it easier for users outside of CRL to understand.

@piyush-singh

piyush-singh Jul 23, 2018

from @Amruta-Ranade : this needs to be simplified to make it easier for users outside of CRL to understand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment