User Interface
Understanding the Diagnostic Tool web page
Last updated
Understanding the Diagnostic Tool web page
Last updated
Once the Diagnostic Tool is connected and you've refreshed the web browser, you will be presented with a dashboard displaying various metrics and performance indicators of your Erigon node. These include but are not limited to:
CPU Usage: How much processor power the node is consuming.
Memory Usage: The amount of RAM occupied by the node.
Network Stats: Information about the data being transmitted and received by your node.
Block Sync Status: The current block height your node is synced to and syncing speed.
Network Stats can help you diagnose connectivity issues or bandwidth limitations that might be affecting your node's performance.
Block Sync Status is crucial for understanding how up-to-date your node is with the blockchain.
The status bar displays essential information about the current active session and the Erigon node being operated.
It also allows users to quickly switch between different sessions and nodes by clicking on the session or node in the status bar. A popup will then appear with a list of available sessions or nodes to switch between.
In the Command ribbon it is possible to inspect the command line arguments that were used to launch the Erigon node.
The Flags section provides a comprehensive view of the configuration settings used to start the Erigon node, including command-line arguments and values from the configuration file. This feature is particularly useful when launching Erigon with a configuration file, as the command-line arguments alone may not fully represent the startup settings.
The flags table in the diagnostics application typically consists of three columns:
Name: Indicates the specific configuration option or setting.
Value: Displays the current value assigned to the corresponding flag.
Default: Shows whether the flag was set by the user or is using the default value. A "false" value indicates that the flag was user-defined, while "true" means the flag is using its default value.
By presenting the configuration flags in a tabular format, operators can easily review and understand the settings applied to the Erigon node, including whether they were explicitly defined or are using the default values. This transparency ensures a clear understanding of the node's configuration, facilitating troubleshooting and optimizing performance.
Contains detailed info about the Erigon node.
The Diagnostic Tool enables remote access to the Erigon node's database via the erigon support tunnel, providing visibility into the node's synchronization progress by reporting the number of synced blocks per stage. This feature enhances operational oversight and aids in optimizing synchronization performance.
This ribbon display reorgs, spotting multiple block headers with the same height but different hashes.
The Diagnostics Tool allows you to collect and view essential information about network peers, enabling you to monitor and manage your network connections effectively. This data includes details about active peers, static peers, total seen peers, and any encountered errors, presented in a tabular format where you can access detailed data for each section by clicking on the respective row.
Active: Displays the number of currently active peers in the network.
Static: Indicates the number of static peers defined in your Erigon configuration.
Total Seen: Shows the total number of peers observed during all diagnostics sessions with the current node.
Total Errors: Provides information about any errors or issues encountered with network peers.
By clicking on the Active, Static, or Total Seen Peers table, you can access detailed information about each peer. The peer details table includes the following columns:
Peer ID: A unique identifier for the peer.
Type: Indicates whether the peer is static, a boot node, or dynamic.
Status: Displays the status of the peer, indicating whether it's currently active.
Total In and Total Out: Shows the total amount of data sent and received over the network
In Speed and Out Speed: display the networking speed of the peer.
Errors Count: Shows the total count of errors encountered with this peer.
This detailed peer information allows you to gain insights into your network connections, helping you troubleshoot and manage your network effectively.
Clicking on a peer row will trigger a pop-up window revealing additional peer details. This window provides insight into the network activities of peers, assisting in troubleshooting, performance optimization, and resource allocation. It offers a straightforward breakdown of peer interactions with the network, enhancing network management and decision-making processes.
Under the Main Info it is given the unique ID of the peer and the total data received (In) and sent (Out) by the peer.
Network Usage By Capability displays the network usage based the capability of the communication channel with the peer.
Network Usage By Type contains the specific protocol messages with the amount of data received and sent for each type.
From this tab it is possible to view and download the node log.
To view the log click on the log name, to download it click on the downward arrow.
Operator has the capability to inspect the databases and their tables. This functionality is implemented in the file internal/erigon_node/remote_db.go.
List Sessions: View active sessions.
Create New Session: Start a new session.
Obtain PIN for Session: Generate a session PIN for security.
Clear All Data: Permanently delete all sessions and data. Use with caution:
Diagnostic Tool updates may contain breaking changes which will result in crashes. To prevent application crashes it is needed to clear data.
Data deletion is irreversible.
