Skip to content

Commit

Permalink
feat: expand upon node setup and monitoring sections
Browse files Browse the repository at this point in the history
  • Loading branch information
anomit committed Jul 17, 2024
1 parent fc19fad commit 1379431
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -320,12 +320,31 @@ Once generated, make sure you assign your burner wallet to your [snapshotter das

This is a one-time configuration process that generates a .env file in the project's root directory.

Everytime you restart the node, you should have a log message similar to the one shown below.
![Start node logs](/images/snapshot-lite-v2-restart-window.png)
Everytime you start or restart the node, it goes through two stages

### Simulation mode submissions

This does not count towards your snapshot quota. This ensures that your node can establish connections to the sequencer over libp2p relay circuits.

:::note
Learn more:
* [Sequencer component](/docs/Protocol/Protocol_v2/sequencer.md)
* [libp2p circuit relay](/docs/Protocol/Protocol_v2/relay.md)
:::

:::info
Read more about monitoring and verifying the simulation mode submissions on the [`Monitoring and Troubleshooting`](/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md) page.
:::
### Regular snapshot submissions

Once you can verify the simulation mode submissions, you will have log messagse similar to the one shown below that will ensure .

If your node is generating snapshots during the assigned timeslot, you should have similar logs in your terminal:
![Sample node logs](/images/snapshot-lite-v2-running.png)

:::info
For further details on using the snapshotter dashboard to monitor the running status of your node, check the [`Monitoring Node Activity with the Snapshotter Dashboard`](/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md#monitoring-node-activity-with-the-snapshotter-dashboard) section.
:::

- To stop the node, you can press `Ctrl+C` in the terminal where the node is running or `docker-compose down` in a new terminal window from the project directory.

This will halt the running node and all associated processes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,34 @@ This section will guide you through the process of Monitoring and Troubleshootin

## Steps to Confirm and Monitor Node Snapshotting Process

1. **Simulation run logs**
### Monitoring Node Activity with the Snapshotter Dashboard
Our Snapshotter Dashboard enables you to verify if your node slot is actively submitting snapshots.

![Snapshotter-node-dashboard](/images/snapshot-lite-v2-dashboard.png)

#### Eligible for simulation bonus rewards

You will see a 'Claim Reward' button next to your slot if you have passed the eligibility criteria of 300 submissions.

![Bonus rewards claim button](/images/node_simulation_bonus_claim.png)

### Terminal Status Check
- The primary method to verify node status is through the terminal, which displays log responses from the node.

- Monitor these logs to assess the health and activity of your node.

- A healthy snapshotter node will produce logs similar to the provided example screenshot. These logs indicate normal operation and successful snapshotting.

![Snapshotter-node-running](/images/snapshotter-node-running-terminal.png)


### Simulation run logs

While running this node for the first time, it performs a couple of dummy submissions to simulate its connections to the relayer and sequencer network. If you notice logs similar to the lines below in the node run logs, your node's simulation run was successful.

![Snapshotter-First-Simulation](/images/snapshot-lite-v2-node-simulation-first-time.png)

2. **Verifying success of simulation run**
#### Verifying success of simulation run

- To verify the success of the same, make use of the utility script bundled within here by running the following on a MacOS/Linux command line terminal.

Expand All @@ -28,20 +49,6 @@ This section will guide you through the process of Monitoring and Troubleshootin
If you observe `submissionCount` and `lastPing` in the above response to be greater than 0, your node's simulation run was successful.
3. **Terminal Status Check:**
- The primary method to verify node status is through the terminal, which displays log responses from the node.
- Monitor these logs to assess the health and activity of your node.
- A healthy snapshotter node will produce logs similar to the provided example screenshot. These logs indicate normal operation and successful snapshotting.
![Snapshotter-node-running](/images/snapshotter-node-running-terminal.png)
4. **Monitoring Node Activity with the Snapshotter Dashboard**
Our Snapshotter Dashboard enables you to verify if your node slot is actively submitting snapshots.
![Snapshotter-node-dashboard](/images/snapshot-lite-v2-dashboard.png)
## Troubleshooting and Support
This section provides guidance on troubleshooting your node in case of encountered issues. The steps outlined below are designed to help identify and resolve common problems efficiently.
Expand Down
Binary file added static/images/node_simulation_bonus_claim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1379431

Please sign in to comment.