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

Show estimation of synchronization metrics on Neuron's page #255

Closed
Keith-CY opened this issue Aug 4, 2023 · 19 comments · Fixed by Magickbase/websites#74
Closed

Show estimation of synchronization metrics on Neuron's page #255

Keith-CY opened this issue Aug 4, 2023 · 19 comments · Fixed by Magickbase/websites#74
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Keith-CY
Copy link
Member

Keith-CY commented Aug 4, 2023

This issue comes from nervosnetwork/neuron#2647


It declares 2 functions:

  1. show the metrics of fully synchronized Neuron
    1. tip block number
    2. disk usage/block size
    3. assumed valid target block number
  2. link to the metrics page on the download page, or prompt the link when synchronization starts from scratch;
  3. optional, add a calculator to estimate the remaining time by uploading log file
@Keith-CY Keith-CY added the documentation Improvements or additions to documentation label Aug 4, 2023
@Keith-CY Keith-CY added this to Neuron Aug 4, 2023
@Danie0918 Danie0918 moved this to 📌Planning in Neuron Aug 4, 2023
@Danie0918
Copy link
Contributor

Danie0918 commented Oct 24, 2023

#235 PRD

【Show estimation of synchronization metrics on Neuron's page】

  • Requirement Description:Full node synchronization requires a large amount of disk space and a long synchronization time, so the estimated metrics data is helpful for users.

show_estimation_of_synchronization_metrics_on_neuron_s_page

  • Requirement Contents
  1. The disk space sets timed tasks to update the data each time a new version is released.
  2. Click Set Path or the Set Path popup appears when synchronizing for the first time.
  3. Add Insufficient disk space prompt:
  • 'Insufficient disk space' pop-up alert, only once per software run.
  • After setting the new disk path, you can click the Migrate Data button.
  • After clicking Migrate Data, migrate the data, close the pop-up window and restart the synchronization.
  • Click Cancel to close the pop-up and not prompt on this run.

New Requirement Contents:

  1. Add "Time Remaining" to synchronization (Display format Hours: Minutes: Seconds)
  2. Eliminate the Refresh Complete popup and add the status to the button.

@Danie0918 Danie0918 moved this from 📌Planning to 🎨 Designing in Neuron Oct 24, 2023
@yanguoyu
Copy link

Optimization Setting-Data Display, change the original path display to disk occupancy display.

Then users can not open the set ckb node path? If we should display the disk left space, this may be limited by the system. For MacOS, the app can only view the appointed directory.

Add Estimated Synchronization Time button, click to upload logs to calculate estimated synchronization time.

Where will these elements show? And app can get the app's log without the user's upload.
image

Additionally, the indexer data has been removed.

@Kirl70
Copy link

Kirl70 commented Nov 1, 2023

Then users can not open the set ckb node path? If we should display the disk left space, this may be limited by the system. For MacOS, the app can only view the appointed directory.

If it's not possible to retrieve the remaining disk space, how about displaying the space occupied by Neuron? This could help users understand how much disk space is being used.

image

@Keith-CY
Copy link
Member Author

Keith-CY commented Nov 1, 2023

I must missed something.

The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

@Danie0918
Copy link
Contributor

I must missed something.

The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

@Keith-CY
Copy link
Member Author

Keith-CY commented Nov 2, 2023

I must missed something.
The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

But the usage of disk is dynamically growing, how can Neuron get the latest estimation without a network requset

@Danie0918
Copy link
Contributor

I must missed something.
The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

But the usage of disk is dynamically growing, how can Neuron get the latest estimation without a network requset

The used capacity here is obtained based on the permissions of the software, and is the space already used rather than the estimated space.

@Keith-CY
Copy link
Member Author

Keith-CY commented Nov 2, 2023

I must missed something.
The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

But the usage of disk is dynamically growing, how can Neuron get the latest estimation without a network requset

The used capacity here is obtained based on the permissions of the software, and is the space already used rather than the estimated space.

I see, and just checked the detailed requirements. So there will be 2 functions

  1. show the estimation of disk usage on the page, the estimation
  2. show available disk space on user's computer and show the insufficient disk space alert when available disk <= minimal requirement

Am I right

@Danie0918
Copy link
Contributor

I must missed something.
The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

But the usage of disk is dynamically growing, how can Neuron get the latest estimation without a network requset

The used capacity here is obtained based on the permissions of the software, and is the space already used rather than the estimated space.

I see, and just checked the detailed requirements. So there will be 2 functions

  1. show the estimation of disk usage on the page, the estimation
  2. show available disk space on user's computer and show the insufficient disk space alert when available disk <= minimal requirement

Am I right

Yes.

@Danie0918
Copy link
Contributor

Then users can not open the set ckb node path? If we should display the disk left space, this may be limited by the system. For MacOS, the app can only view the appointed directory.

If it's not possible to retrieve the remaining disk space, how about displaying the space occupied by Neuron? This could help users understand how much disk space is being used.

image

In this way, we can display the used space and help users to understand the data storage situation when the disk space is not available.What do you think? @yanguoyu

@Keith-CY
Copy link
Member Author

Keith-CY commented Nov 2, 2023

I must missed something.
The feature request is to show the disk usage on neuron's project page, not inside neuron. It's used to inform users about the minimal requirements before they download neuron.

This is an additional requirement to help users understand disk space usage.

But the usage of disk is dynamically growing, how can Neuron get the latest estimation without a network requset

The used capacity here is obtained based on the permissions of the software, and is the space already used rather than the estimated space.

I see, and just checked the detailed requirements. So there will be 2 functions

  1. show the estimation of disk usage on the page, the estimation
  2. show available disk space on user's computer and show the insufficient disk space alert when available disk <= minimal requirement

Am I right

Yes.

Cool, I would add a detail about showing insufficient disk space. An exception will be thrown from ckb node when disk space runs out

IO error: No space left on device

@yanguoyu
Copy link

@yanguoyu yanguoyu moved this from 🏗 In Progress to 🔎 Code Review in Neuron Dec 29, 2023
@yanguoyu yanguoyu moved this from 🔎 Code Review to 👀 Testing in Neuron Jan 24, 2024
@Danie0918 Danie0918 moved this from 👀 Testing to 🚩Pre Release in Neuron Feb 4, 2024
@Keith-CY
Copy link
Member Author

Keith-CY commented Feb 7, 2024

As mentioned in the top message

link to the metrics page on the download page, or prompt the link when synchronization starts from scratch;

There is still some work on the project page, an obvious, real-time disk usage along with the download link.

@Danie0918 Danie0918 assigned Danie0918 and unassigned silySuper Apr 1, 2024
@Danie0918 Danie0918 moved this from 🚩Pre Release to 🏗 In Progress in Neuron Apr 1, 2024
@Danie0918
Copy link
Contributor

Danie0918 commented Apr 1, 2024

As mentioned in the top message

link to the metrics page on the download page, or prompt the link when synchronization starts from scratch;

There is still some work on the project page, an obvious, real-time disk usage along with the download link.

PRD:https://ndephi.axshare.com

Data Interface: Magickbase/infra#78

UI:
Pop-up Window: https://www.figma.com/file/6XNoimRDbFTTNm016rbIdU/Magickbase?type=design&node-id=36388%3A2209&mode=design&t=fZd9nAQo8EoYbg3g-1

Download Page: https://www.figma.com/file/6XNoimRDbFTTNm016rbIdU/Magickbase?type=design&node-id=19033%3A39943&mode=design&t=fZd9nAQo8EoYbg3g-1

@Keith-CY
Copy link
Member Author

Keith-CY commented Apr 2, 2024

Any update on this @PainterPuppets

@Danie0918
Copy link
Contributor

Any update on this @PainterPuppets

Expected to submit pr today.

@PainterPuppets
Copy link

Any update on this @PainterPuppets

Submitted.

@Danie0918
Copy link
Contributor

PR:Magickbase/websites#74

@Danie0918 Danie0918 moved this from 🏗 In Progress to ✅ Done in Neuron Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

10 participants