Setup

How to connect the Diagnostic Tool to your Erigon node

To be able to monitor your node through the Diagnostic Tool you must connect them.

The step needed to connect are:

1. Run your Erigon node

2. Run the Diagnostic Tool

3. Create a new session in the Diagnostic Tool

4. Connect the Diagnostic Tool to your node

5. Refresh the Diagnostic Tool

1. Run your Erigon node

If you are not sure what to run, start from a test-net with Caplin as the Consensus Engine.

./build/bin/erigon --chain=holesky

2. Run the Diagnostic Tool

Run the Diagnostic Tool application from the machine where you intend to monitor your node.

cd diagnostics
make run-self-signed

Starting up the application may take a while.

More options can be found here.

The Diagnostic Tool page will automatically open in your browser at the address http://localhost:8080.

The Diagnostic Tool web-page

Leaving the terminal session will close the Diagnostic Tool interface.

3. Create a new session in the Diagnostic Tool

The Diagnostic Tool is now operational, but to access the data, it must be integrated with the Erigon node. Proceed to the Admin section in the left navigation menu and select Create Session. Assign a name to your session and click Create to proceed.

Creating a new session in Erigon Diagnostic Tool

Upon successful creation of a new session, it will be allocated a unique 8-digit code which will be YOUR_SESSION_PIN. You can locate this PIN displayed adjacent to the session in the list of created sessions.

Click on the copy button to copy the session ID to your clipboard

At this time it is possible to create only a single session. However, support for multiple concurrent sessions will be added in the future.

4. Connect the Diagnostic Tool to your node

Local Node

If your Erigon node is running on your local machine, open a new console window in the Erigon folder and run the following command:

./build/bin/erigon support --diagnostics.sessions YOUR_SESSION_PIN

Replace YOUR_SESSION_PIN with the 8-digit PIN allocated to your session during the previous step, for example:

./build/bin/erigon support diagnostics.sessions 15498880

This command will attach the Diagnostics Tool to the Erigon node using the provided session pin.

Remote Node

If your Erigon node is running on a Virtual Private Server (VPS) such as Amazon AWS, you can connect the Diagnostic Tool on your local machine with ngrok utility.

ngrok was chosen because of its easy of use and because the free version is useful for our scope. It is possible to use any other similar tool.

1. You can run ngrok on your local machine in order to tunnel localhost:8080

ngrok http http://localhost:8080

1. The ngrok utility will start and return a page similar to the below example:

1. Your diagnostic address is in the Forwarding field. Copy only the part of the address after the URL prefix https://, in this case e98b-95-245-79-203.ngrok-free.app .

2. In the machine hosting your Erigon node, go to the Erigon directory and run this command to attach the Diagnostic Tool to the Erigon node:

./build/bin/erigon support --diagnostics.addr YOUR_DIAGNOSTIC_ADDRESS --diagnostics.sessions YOUR_SESSION_PIN

1. Replace YOUR_DIAGNOSTIC_ADDRESS with the address obtained with ngrok

2. Replace YOUR_SESSION_PIN with your session PIN from point 3. For example:

./build/bin/erigon support --diagnostics.addr e98b-95-245-79-203.ngrok-free.app --diagnostics.sessions 14606762

By following these steps, you can establish a connection between the Diagnostic Tool on your local machine and the Erigon node running on the VPS, enabling you to monitor and diagnose the node's performance.

More information about the erigon support command can be find here.

5. Refresh the Diagnostic Tool

Once the diagnostics tool is successfully connected to the Erigon node, return to your web browser and reload the page.

This step is necessary to query data from the connected node.

User Interface