Sui Sonar is a monitoring platform for Sui node operators that provide a variety of comprehensible user and role based alerts and commands to gather Sui blockchain information.
[JOIN SUI SONAR DISCORD](https://discord.gg/mU2JANKT)
## Features
- 📡﹒Networks: Sui Sonar is available for Sui `mainnet` and `testnet` networks so you can track your validator in both networks.
- 📲﹒Integrations: it integrates with several communication channels
- Sonar Discord server: main communication channel where all alerts and commands are available
- Telegram: Sonar can send messages to your private Telegram bot if you want to
- Discord external servers: Sonar can send message to your private Discord server
Sui Sonar consists of 2 main features: alerts and commands.
- 📢﹒Alerts: are messages sent by the bot tagging users and/or roles to let users know about important monitoring events. The following alert types are available:
- Validator:
- changes in commission
- gas prices
- metadata
- stake
- tally score
- Node status:
- changes in sync status
- peer connectivity
- version
- Epochs:
- epoch changes
- gas submission
- stake changes
- reported validators
- Network:
- version changes
- changes in TPS
- network stops
- Sui Token:
- sudden price changes
- 20% price changes between epochs
- Performance:
- certificates creation
- consensus latency
- execution latency
-> Check all alerts in [Available Alerts](Available-Alerts)
- ⌨️﹒Commands: are messages sent by the user to Sui Sonar bot to retrieve useful data about Sui blockchain. The following commands are available:
- Status: displays validator and node information (commission, gas, performance, stake, etc.)
- Validators: different list of validators (general info, gas prices, RGP, etc.)
- Epochs: list of latest epochs information (version, TPS, RGP, Sui token price, etc.)
- Token: displays Sui token market information (price, volume, price changes, etc.)
- Tps: displays current transactions per second of the network
- Register: different register/subscribe commands to subscribe to alerts and communication channels
-> Check all commands in [Available Commands](Available-Commands)
## Access
The first thing to do is join Sui Sonar Discord server with the following link.
[JOIN SUI SONAR DISCORD](https://discord.gg/mU2JANKT)
Once on the Discord server, to gain access to testnet and mainnet alerts channels you need the `@validator` role. For that, you have to go to the `#rules` channel and react to the roles message with required 🖥️ emoji. You have other roles to get alerts for specific network, token, governance, etc. events, but these are optional.
Now that you have your `@validator` role you can access the `#sonar-mainnet` and `#sonar-testnet` channels to execute commands and receive alerts.
## Susbscribe to Alerts
To be tagged on validator alerts, you have to subscribe to your validator node with the alert command specifying your validator address.
Now your ready to go. To unsubscribe from alerts just execute.
```
!alert disable
```
You can also subscribe to generic alerts not related to your validator by acquiring the related Discord role. Roles are available in the #rules channel. You get the role by reacting with the emoji corresponding to the roles message. The available alert roles are:
- 🌐﹒network alerts: related to blockchain events
- ⏱️﹒epoch alerts: related to epoch events
- 🗳️﹒governance alerts: related to governance events (gas, tally)
- 🪙﹒token alerts: related to Sui token price events
## Register a Node
If you want to go further and want Sonar to meassure your validator node's performance, you can register your node by specifying: validator addrees, node url/ip and metrics port.
For registering your node it's required that the /metrics endpoint is accessible by Sui Sonar server, so you need to whitelist the following IP 193.34.212.90 in your firewall rules.
Here is an example on how to do so with ufw:
```
sudo ufw allow from 193.34.212.90 proto tcp to any port 9184
