Skip to content

Commit

Permalink
Updated readme, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
olton committed Jul 11, 2021
1 parent f335902 commit c9a8572
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 21 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
### 1.1.1
+ [x] Server: improved alerts for `FORKs`
+ [x] Server: improved alerts for `FORK` states
+ [x] Server: added alert for `NO PEERS` state
+ [x] Server: node info now stored into local object every time interval defined in `consfig.nodeInfoCollectInterval`
+ [x] Server: added config property `config.blockSpeedDistance` with default value `10` to calculate blockchain speed
+ [x] Server: information about mina now return from stored object
+ [x] Server: added request for node health, request return empty array if `OK` or filled array with critical states
+ [x] Server: alerter now use stored node info
+ [x] Server: added config properties `hangInterval`, `hangIntervalAlert`
+ [x] Server: config option `restartAfterPrev` is deprecated, use `hangInterval`
+ [x] Server: improved alerts for `HANG` state
+ [x] Server: added config properties `hangInterval`, `hangIntervalAlert`, config option `restartAfterPrev` is deprecated, use `hangInterval`
+ [x] Server: added config options `memAlert`, `memRestart` as a percent value (0 - 100)

+ [x] Client: added reaction for node health request
Expand Down
31 changes: 26 additions & 5 deletions README.RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,32 @@ where
- `nodeInfoCollectInterval` - interval to collect node info into internal object. Recommended value `30000` (30 sec)
- `hangIntervalAlert` - time to alert when node hanging
- `hangInterval` - time to restart when node hanging

**Restart if `Critical memmory usage` state detected**
To check memory state use config props:
- `memAlert` - percent value from 0 to 100 (0 - no detect)
- `memRestart` - percent value from 0 to 100 (0 - no restart)
- `memAlert` - value to alert when critical memory usage (0 - 100), 0 - no alert
- `memRestart` - value to restart when critical memory usage (0 - 100), 0 - no restart

**Values for alerts: `alertToTelegram`, `alertToDiscord`**
- `HELLO` - node says Hello
- `NOT-SYNCED` - node not `SYNCED`
- `MAX` - block height less than max block length
- `FORWARD-MAX` - block height more than max block length
- `FORK` - block height less than max unvalidated block length
- `FORWARD-FORK` - block height more than max unvalidated block length
- `HANG` - node in hanging state
- `EXPLORER` block height more or less of Mina Explorer height
- `RESTART` - alert when restart exec
- `BALANCE` - send balance
- `PEERS` - send alert if node don't has a peers
- `MEM` - send alert if critical memory usage detected

**Values for restart: `restartStateSyncedRules`**
- `MAX` - restart when height less than max block length
- `FORWARD-MAX` - restart when height more than max block length
- `FORK` - restart when height less than max unvalidated block length
- `FORWARD-FORK` - restart when height more than max unvalidated block length
- `HANG` - restart hanging detected

**Alert and Restart when critical memory usage**
These rules are controlled by parameters `memAlert` and `memRestart`.

### Сборка клиентского приложения

Expand Down
31 changes: 26 additions & 5 deletions README.UA.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,11 +218,32 @@ where
- `nodeInfoCollectInterval` - interval to collect node info into internal object. Recommended value `30000` (30 sec)
- `hangIntervalAlert` - time to alert when node hanging
- `hangInterval` - time to restart when node hanging

**Restart if `Critical memmory usage` state detected**
To check memory state use config props:
- `memAlert` - percent value from 0 to 100 (0 - no detect)
- `memRestart` - percent value from 0 to 100 (0 - no restart)
- `memAlert` - value to alert when critical memory usage (0 - 100), 0 - no alert
- `memRestart` - value to restart when critical memory usage (0 - 100), 0 - no restart

**Values for alerts: `alertToTelegram`, `alertToDiscord`**
- `HELLO` - node says Hello
- `NOT-SYNCED` - node not `SYNCED`
- `MAX` - block height less than max block length
- `FORWARD-MAX` - block height more than max block length
- `FORK` - block height less than max unvalidated block length
- `FORWARD-FORK` - block height more than max unvalidated block length
- `HANG` - node in hanging state
- `EXPLORER` block height more or less of Mina Explorer height
- `RESTART` - alert when restart exec
- `BALANCE` - send balance
- `PEERS` - send alert if node don't has a peers
- `MEM` - send alert if critical memory usage detected

**Values for restart: `restartStateSyncedRules`**
- `MAX` - restart when height less than max block length
- `FORWARD-MAX` - restart when height more than max block length
- `FORK` - restart when height less than max unvalidated block length
- `FORWARD-FORK` - restart when height more than max unvalidated block length
- `HANG` - restart hanging detected

**Alert and Restart when critical memory usage**
These rules are controlled by parameters `memAlert` and `memRestart`.

### Збірка клієнтського додатка

Expand Down
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,11 +209,32 @@ where
- `nodeInfoCollectInterval` - interval to collect node info into internal object. Recommended value `30000` (30 sec)
- `hangIntervalAlert` - time to alert when node hanging
- `hangInterval` - time to restart when node hanging

**Restart if `Critical memmory usage` state detected**
To check memory state use config props:
- `memAlert` - percent value from 0 to 100 (0 - no detect)
- `memRestart` - percent value from 0 to 100 (0 - no restart)
- `memAlert` - value to alert when critical memory usage (0 - 100), 0 - no alert
- `memRestart` - value to restart when critical memory usage (0 - 100), 0 - no restart

**Values for alerts: `alertToTelegram`, `alertToDiscord`**
- `HELLO` - node says Hello
- `NOT-SYNCED` - node not `SYNCED`
- `MAX` - block height less than max block length
- `FORWARD-MAX` - block height more than max block length
- `FORK` - block height less than max unvalidated block length
- `FORWARD-FORK` - block height more than max unvalidated block length
- `HANG` - node in hanging state
- `EXPLORER` block height more or less of Mina Explorer height
- `RESTART` - alert when restart exec
- `BALANCE` - send balance
- `PEERS` - send alert if node don't has a peers
- `MEM` - send alert if critical memory usage detected

**Values for restart: `restartStateSyncedRules`**
- `MAX` - restart when height less than max block length
- `FORWARD-MAX` - restart when height more than max block length
- `FORK` - restart when height less than max unvalidated block length
- `FORWARD-FORK` - restart when height more than max unvalidated block length
- `HANG` - restart hanging detected

**Alert and Restart when critical memory usage**
These rules are controlled by parameters `memAlert` and `memRestart`.

### Build web client
To build client use command:
Expand Down
7 changes: 4 additions & 3 deletions WHATS_NEW.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
### 1.1.1
+ [x] New algorithm to check node hanging
+ [x] New alert for `NO PEERS` state
+ [x] Added `health` object for node to display node health on client.
+ [x] Big changes for improving server-side
+ [x] Restart node if `Critical memory usage` is detected
+ [x] `health` object for node to display node health on client (`OK`, `FORK`, `UNKNOWN`, `NO PEERS`, `NOT-SYNCED`).
+ [x] Many changes for improving work of the server-side
+ [x] Alert and restart node if `Critical memory usage` state detected
+ [x] Can be used for `Mina Monitor Cluster`

### 1.0.5 -> 1.1.0
+ [x] Alert to Discord
Expand Down

0 comments on commit c9a8572

Please sign in to comment.