Skip to content

Commit

Permalink
feat: added new info about logs and config features (sigp#4378)
Browse files Browse the repository at this point in the history
## Proposed Changes

Add additional information about Siren's new configuration, dashboard and logs view features.
  • Loading branch information
rickimoore authored and isaac.asimov committed Jul 13, 2023
1 parent ab6112c commit da91b60
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 0 deletions.
Binary file added book/src/imgs/ui-dash-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/src/imgs/ui-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions book/src/ui-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,13 @@ Once you have successfully arrived to the main dashboard, use the sidebar to acc

## 5. Why doesn't my validator balance graph show any data?
If your graph is not showing data, it usually means your validator node is still caching data. The application must wait at least 3 epochs before it can render any graphical visualizations. This could take up to 20min.

## 4. Does Siren support reverse proxy or DNS named addresses?
Yes, if you need to access your beacon or validator from an address such as `https://merp-server:9909/eth2-vc` you should follow the following steps for configuration:
1. Toggle `https` as your protocol
2. Add your address as `merp-server/eth2-vc`
3. Add your Beacon and Validator ports as `9909`

If you have configured it correctly you should see a green checkmark indicating Siren is now connected to your Validator Client and Beacon Node.

If you have separate address setups for your Validator Client and Beacon Node respectively you should access the `Advance Settings` on the configuration and repeat the steps above for each address.
16 changes: 16 additions & 0 deletions book/src/ui-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ By clicking on the chart component you can filter selected validators in the ren
<img src="imgs/ui-validator-balance2.png" width="48%"/>



## Hardware Usage and Device Diagnostics

The hardware usage component gathers information about the device the Beacon Node is currently running. It displays the Disk usage, CPU metrics and memory usage of the Beacon Node device. The device diagnostics component provides the sync status of the execution client and beacon node.
Expand All @@ -42,6 +43,12 @@ The hardware usage component gathers information about the device the Beacon Nod
<img height="350" src="imgs/ui-device.png"/>


## Log Statistics

The log statistics present an hourly combined rate of critical, warning, and error logs from the validator client and beacon node. This analysis enables informed decision-making, troubleshooting, and proactive maintenance for optimal system performance.

<img height="350" src="imgs/ui-dash-logs.png"/>

# Validator Management

Siren's validator management view provides a detailed overview of all validators with options to deposit to and/or add new validators. Each validator table row displays the validator name, index, balance, rewards, status and all available actions per validator.
Expand All @@ -59,3 +66,12 @@ Clicking the validator icon activates a detailed validator modal component. This
Siren's settings view provides access to the application theme, version, name, device name and important external links. From the settings page users can also access the configuration screen to adjust any beacon or validator node parameters.

![](imgs/ui-settings.png)


# Validator and Beacon Logs

The logs page provides users with the functionality to access and review recorded logs for both validators and beacons. Users can conveniently observe log severity, messages, timestamps, and any additional data associated with each log entry. The interface allows for seamless switching between validator and beacon log outputs, and incorporates useful features such as built-in text search and the ability to pause log feeds.

Additionally, users can obtain log statistics, which are also available on the main dashboard, thereby facilitating a comprehensive overview of the system's log data. Please note that Siren is limited to storing and displaying only the previous 1000 log messages. This also means the text search is limited to the logs that are currently stored within Siren's limit.

![](imgs/ui-logs.png)

0 comments on commit da91b60

Please sign in to comment.