Skip to content

Commit

Permalink
Merge pull request #25 from bartosian/kb/hotfix/updated-docs-for-new-…
Browse files Browse the repository at this point in the history
…tables

Updated Documentation for new tables
  • Loading branch information
bartosian authored Jan 21, 2024
2 parents 1441622 + fb50629 commit 230de89
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 2 deletions.
60 changes: 59 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ So if you're looking for a powerful, reliable tool for monitoring the SUI networ
- [Windows](#windows)
- [Build and Installation from Source](#build-and-installation-from-source)
- [Installation using Homebrew](#installation-using-homebrew)
- [Upgrading Suimon using Homebrew](#upgrading-suimon-using-homebrew)
- [Suimon Configuration Files](#suimon-configuration-files)
- [Example Suimon Config Directory](#example-suimon-config-directory)
- [Suimon Configuration Fields](#suimon-configuration-fields)
Expand Down Expand Up @@ -156,6 +157,48 @@ For macOS users, suimon can be seamlessly installed using the Homebrew package m
- Following the installation, it's essential to set up the suimon configuration file. Detailed instructions for this setup are provided in the subsequent section of this document.
Upon completion of these steps, suimon will be configured and ready for use on your macOS system.
## Upgrading Suimon using Homebrew
For macOS users who have previously installed Suimon via Homebrew, upgrading to the latest version can be done efficiently. Follow these steps to ensure Suimon is up-to-date and functioning optimally.
1. **Update Homebrew Repository**
- Before upgrading, ensure your Homebrew repository is up to date:
```
brew update
```
2. **Upgrade Suimon**
- Once the repository is updated, proceed to upgrade Suimon:
```
brew upgrade suimon
```
3. **Verify the Upgrade**
- After the upgrade, it's a good practice to check the installed version of Suimon:
```
suimon version
```
Occasionally, cache-related issues might occur, causing problems with the installation or upgrade process. To resolve these issues:
1. **Clear Homebrew Cache**
- Clear the Homebrew cache to remove any corrupted or outdated files:
```
brew cleanup
```
2. **Reinstall Suimon (Optional)**
- If issues persist after cleaning the cache, a fresh reinstall of Suimon might be necessary:
```
brew reinstall suimon
```
For macOS users, suimon can be seamlessly installed using the Homebrew package manager. Please adhere to the subsequent steps to facilitate the installation.
## Suimon Configuration Files
Expand Down Expand Up @@ -300,11 +343,13 @@ Tables are static monitors that provide a detailed snapshot of the network and i
| 📡 PUBLIC RPC | Displays detailed information about the network's RPC endpoints. |
| 💻 FULL NODES | Displays detailed information about the network's nodes. |
| 🤖 VALIDATORS | Displays detailed information about the network's validators. |
| 💾 SYSTEM STATE | Displays the current gas price and subsidy values for the network. |
| 💾 SYSTEM STATE | Displays the current gas price and subsidy values in the network. |
| 🌐 PROTOCOL | Displays the protocol config for the latest version number. |
| 📊 VALIDATORS PARAMS | Displays the validators related thresholds and counts on the network. |
| 🚨 VALIDATORS AT RISK | Displays the number of validators that are currently at risk of being slashed.|
| 📢 VALIDATORS REPORTS | Displays the latest reports submitted by validators. |
| ✅ ACTIVE VALIDATORS | Displays the current list of active validators on the network. |
| 📈 RELEASE HISTORY | Displays the release history for the selected network. |

### Table Examples

Expand Down Expand Up @@ -336,6 +381,13 @@ Tables are static monitors that provide a detailed snapshot of the network and i
![Screenshot of my app](static/images/table-system-state.png)
<br><br>

- `🌐 PROTOCOL`
<br><br>
This table provides a detailed view of the protocol configuration for the latest version of the software. It includes key information such as version number, release date, and a comprehensive list of settings and parameters defined in the current version.
<br><br>
![Screenshot of my app](static/images/table-protocol.png)
<br><br>

- `📊 VALIDATORS PARAMS`
<br><br>
This table provides information about network thresholds and parameters for validators. This table provides information about the number of validators in various states, such as active, pending, and at risk, as well as the minimum stake threshold required for validation, and other system-wide metrics.
Expand All @@ -356,6 +408,12 @@ Tables are static monitors that provide a detailed snapshot of the network and i
<br><br>
![Screenshot of my app](static/images/table-active-validators.png)

- `📈 RELEASE HISTORY`
<br><br>
This table presents a comprehensive overview of the release history for specific networks such as mainnet, testnet, among others. It details various releases, including their dates, versions, features, and changes implemented in each network iteration.
<br><br>
![Screenshot of my app](static/images/table-releases.png)

## Dashboards

Dashboards are dynamic monitors that provide real-time information about the network and its entities. Unlike static tables, which provide a snapshot of the network at a specific point in time, dashboards continuously update and display data in real-time.
Expand Down
Binary file removed assets/screenshot_01.png
Binary file not shown.
Binary file removed assets/screenshot_02.png
Binary file not shown.
Binary file removed assets/screenshot_03.png
Binary file not shown.
Binary file removed assets/suimon.png
Binary file not shown.
2 changes: 1 addition & 1 deletion internal/core/controllers/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"github.com/bartosian/suimon/internal/core/ports"
)

const version = "v1.1.0"
const version = "v1.2.2"

type VersionController struct {
cliGateway *cligw.Gateway
Expand Down
Binary file added static/images/table-protocol.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 static/images/table-releases.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 230de89

Please sign in to comment.