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

Add documentation on node debug page #26

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add documentation on node debug page #26

wants to merge 2 commits into from

Conversation

janewang
Copy link
Contributor

@janewang janewang commented May 3, 2022

No description provided.

@render
Copy link

render bot commented May 3, 2022

@janewang janewang self-assigned this May 3, 2022
@jc-near jc-near requested a review from mm-near May 3, 2022 20:17
docs/troubleshooting/node-debug.md Outdated Show resolved Hide resolved
docs/troubleshooting/node-debug.md Outdated Show resolved Hide resolved
- `Route to validators`: The list of validators that this node is one-hop away.


### Chain Info
Copy link

Choose a reason for hiding this comment

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

@jc-near we might want to change the naming of the pages a little ;-)

As stuff on this page (orphans, missing chunks etc) - are more related with 'Sync'

And maybe we should rename the 'sync info' page to 'network' (and move current Sync Status here)

Copy link

Choose a reason for hiding this comment

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

Cool. I will create a PR to do this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @jc-near @mm-near. Ok we will do another round of documentation when those are finalized.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jc-near @mm-near What do you think about adding on the Sync Page, which peer has missed a block in the epoch and is a bad peer? Also any updates on the PR, thanks

Copy link

Choose a reason for hiding this comment

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

some of this data is already there (for example: if a peer missed a block, we show it on the last_blocks page -- but only for the last 50 blocks).

But yes, we could show it more explicitly. Could you create an issue for that?
(preferably with more details - how bad peers should be shown etc etc).

docs/troubleshooting/node-debug.md Outdated Show resolved Hide resolved
docs/troubleshooting/node-debug.md Outdated Show resolved Hide resolved

The table below displays the validator history in the current epoch and the last five epochs (represented by the epoch hash) with either TRUE or FALSE.


Copy link

Choose a reason for hiding this comment

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

we could also mention, that they can see the example here:
http://34.147.91.25:3030/debug

(but we might want to get a 'better URL' in the future, as this IP can change)

@nikurt nikurt requested a review from gmilescu as a code owner April 17, 2023 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants