Skip to content

Commit 269a389

Browse files
committed
updated readme
1 parent f93e7c5 commit 269a389

File tree

4 files changed

+167
-36
lines changed

4 files changed

+167
-36
lines changed

ABOUT.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# About Mina Monitor
2+
3+
### English
4+
5+
**Monitor Client:**
6+
- [x] Display of the main indicators of the Mina network (Block height, uptime, epoch and slot info)
7+
- [x] Displaying the status of the node daemon (SYNCED, CATCHUP, BOOTSTRAP, ...)
8+
- [x] Displaying the health of node (OK, Fork, Hanging)
9+
- [x] Displaying the server resources consumed by the node (CPU, RAM, NETWORK)
10+
- [x] Displaying the balance of the specified address and the value of this balance in different currencies
11+
- [x] Displaying information about delegations to the specified validator address
12+
- [x] Displaying information about blocks won and rewards received in the current era
13+
- [x] Displays general information about the site server
14+
- [x] Convenient live graphs for displaying consumed resources
15+
- [x] Responsive interface (It is comfortable to look at both PC and phone and tablet)
16+
17+
**Cluster Client:**
18+
- [x] Anything that a simple client displays, plus
19+
- [x] Displaying the status of several (up to 3) nodes on one page
20+
- [x] Cyclic bypass of nodes, polling of general information for the address is carried out sequentially from synchronized nodes
21+
- [x] Displaying the response rate of a GraphQL node to the main request
22+
23+
> You can find `Monitor Cluster` in [this repo](https://github.com/olton/mina-monitor-cluster)
24+
25+
**Monitor Server Side:**
26+
- [x] Monitoring node health
27+
- [x] Identification of critical node states (fork, forward fork, node freeze, lag/lead Mina Explorer)
28+
- [x] Determining the Synchronization State of a Node
29+
- [x] Automatic reboot of the node in case of critical state detection
30+
- [x] Sending messages about the critical state of the node in Telegram and/or Discord
31+
- [x] Sending the current balance of the specified address to Telegram and/or Discord
32+
- [x] Sending Mina's cost to Telegram and/or Discord
33+
- [x] Disabling snark-worker before block production and then resuming its work
34+
- [x] Monitor memory consumption and reboot node when memory is critical
35+
36+
### Українська
37+
38+
**Monitor Client:**
39+
- [x] Відображення основних показників мережі Mina (Block height, uptime, epoch and slot info)
40+
- [x] Відображення стану демона вузла (SYNCED, CATCHUP, BOOTSTRAP, ...)
41+
- [x] Відображення здоров'я вузла (ОК, Fork, Hanging)
42+
- [x] Відображення споживаних вузлом ресурсів сервера (CPU, RAM, NETWORK)
43+
- [x] Відображення балансу зазначеного адресу і вартості цього балансу в різних валютах
44+
- [x] Відображення інформації про делегаціях на вказану адресу валідатора
45+
- [x] Відображення інформації про виграних блоках і отриманому винагороду в поточній епосі
46+
- [x] Відображення загальної інформації про сервер вузла
47+
- [x] Зручні живі графіки для відображення споживаних ресурсів
48+
- [x] Чуйний (responsive) інтерфейс (Комфортно дивитися і на ПК і на телефоні і на планшеті)
49+
50+
**Monitor Cluster:**
51+
- [x] Все, що відображає простий клієнт, плюс
52+
- [x] Відображення стану декількох (до 3-х) вузлів на одній сторінці
53+
- [x] Циклічний обхід вузлів, опитування загальної інформації для адреси здійснюється послідовно з синхронізованих вузлів
54+
- [x] Відображення швидкості відповіді GraphQL вузла на основний запит
55+
56+
> Ви можете знайти `Monitor Cluster` в [цьому репозиторії](https://github.com/olton/mina-monitor-cluster)
57+
58+
**Monitor Server Side:**
59+
- [x] Контроль здоров'я вузла
60+
- [x] Визначення критичних станів (форк, випереджаюче форк, зависання вузла, відставання / випередження Mina Explorer)
61+
- [x] Визначення стану синхронізації вузла
62+
- [x] Автоматичне перезавантаження вузла в разі виявлення критичного стану
63+
- [x] Відправлення повідомлень про критичний стан вузла в Telegram та/або Discord
64+
- [x] Відправка поточного балансу зазначеного адреса в Telegram та/або Discord
65+
- [x] Відправка вартості Міни в Telegram та/або Discord
66+
- [x] Відключення snark-worker перед виробництвом блоку і подальше відновлення його роботи
67+
- [x] Контроль споживання пам'яті та перезавантаження вузла при критичному використанні пам'яті
68+
69+
### Русский
70+
71+
**Monitor Client:**
72+
- [x] Отображение основных показателей сети Мина (Block height, uptime, epoch and slot info)
73+
- [x] Отображение состояния демона узла (SYNCED, CATCHUP, BOOTSTRAP, ...)
74+
- [x] Отображение здоровья узла (ОК, Fork, Hanging)
75+
- [x] Отображение потребляемых узлом ресурсов сервера (CPU, RAM, NETWORK)
76+
- [x] Отображение баланса указанного адрес и стоимости этого баланса в различных валютах
77+
- [x] Отображение информации о делегациях на указанный адрес валидатора
78+
- [x] Отображение информации о выигранных блоках и полученном вознаграждении в текущей эпохе
79+
- [x] Отображение общей информации о сервере узла
80+
- [x] Удобные живые графики для отображения потребляемых ресурсов
81+
- [x] Отзывчивый (responsive) интерфейс (Комфортно смотреть и на ПК и на телефоне и на планшете)
82+
83+
**Monitor Cluster:**
84+
- [x] Все, что отображает простой клиент, плюс
85+
- [x] Отображение состояния нескольких (до 3-х) узлов на одной странице
86+
- [x] Циклический обход узлов, опрос общей информации для адреса осуществляется последовательно с синхронизированных узлов
87+
- [x] Отображение скорости ответа GraphQL узла на основной запрос
88+
89+
> Вы можете найти `Monitor Cluster` в [этом репозитории](https://github.com/olton/mina-monitor-cluster)
90+
91+
**Monitor Server Side:**
92+
- [x] Контроль здоровья узла
93+
- [x] Определение критических состояний (форк, опережающий форк, зависание узла, отставание/опережение Mina Explorer)
94+
- [x] Определение состояния синхронизированности узла
95+
- [x] Автоматическая перезагрузка узла в случае обнаружения критического состояния
96+
- [x] Отправка сообщений о критическом состоянии узла в Телеграм и/или Дискорд
97+
- [x] Отправка текущего баланса указанного адрес в Телеграм и/или Дискорд
98+
- [x] Отправка стоимости Мины в Телеграм и/или Дискорд
99+
- [x] Отключение snark-worker перед производством блока и последующее возобновление его работы
100+
- [x] Контроль потребления памяти и перезагрузка узла при критическом использовании памяти

README.RU.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,35 @@
99
## Основные возможности
1010

1111
**Monitor Client:**
12-
- [x] Display of the main indicators of the Mina network (Block height, uptime, epoch and slot info)
13-
- [x] Displaying the status of the node daemon (SYNCED, CATCHUP, BOOTSTRAP, ...)
14-
- [x] Displaying the health of node (OK, Fork, Hanging)
15-
- [x] Displaying the server resources consumed by the node (CPU, RAM, NETWORK)
16-
- [x] Displaying the balance of the specified address and the value of this balance in different currencies
17-
- [x] Displaying information about delegations to the specified validator address
18-
- [x] Displaying information about blocks won and rewards received in the current era
19-
- [x] Displays general information about the site server
20-
- [x] Convenient live graphs for displaying consumed resources
21-
- [x] Responsive interface (It is comfortable to look at both PC and phone and tablet)
12+
- [x] Отображение основных показателей сети Мина (Block height, uptime, epoch and slot info)
13+
- [x] Отображение состояния демона узла (SYNCED, CATCHUP, BOOTSTRAP, ...)
14+
- [x] Отображение здоровья узла (ОК, Fork, Hanging)
15+
- [x] Отображение потребляемых узлом ресурсов сервера (CPU, RAM, NETWORK)
16+
- [x] Отображение баланса указанного адрес и стоимости этого баланса в различных валютах
17+
- [x] Отображение информации о делегациях на указанный адрес валидатора
18+
- [x] Отображение информации о выигранных блоках и полученном вознаграждении в текущей эпохе
19+
- [x] Отображение общей информации о сервере узла
20+
- [x] Удобные живые графики для отображения потребляемых ресурсов
21+
- [x] Отзывчивый (responsive) интерфейс (Комфортно смотреть и на ПК и на телефоне и на планшете)
22+
23+
**Monitor Cluster:**
24+
- [x] Все, что отображает простой клиент, плюс
25+
- [x] Отображение состояния нескольких (до 3-х) узлов на одной странице
26+
- [x] Циклический обход узлов, опрос общей информации для адреса осуществляется последовательно с синхронизированных узлов
27+
- [x] Отображение скорости ответа GraphQL узла на основной запрос
28+
29+
> Вы можете найти `Monitor Cluster` в [этом репозитории](https://github.com/olton/mina-monitor-cluster)
2230
2331
**Monitor Server Side:**
24-
- [x] Monitoring node health
25-
- [x] Identification of critical node states (fork, forward fork, node freeze, lag/lead Mina Explorer)
26-
- [x] Determining the Synchronization State of a Node
27-
- [x] Automatic reboot of the node in case of critical state detection
28-
- [x] Sending messages about the critical state of the node in Telegram and/or Discord
29-
- [x] Sending the current balance of the specified address to Telegram and/or Discord
30-
- [x] Sending Mina's cost to Telegram and/or Discord
32+
- [x] Контроль здоровья узла
33+
- [x] Определение критических состояний (форк, опережающий форк, зависание узла, отставание/опережение Mina Explorer)
34+
- [x] Определение состояния синхронизированности узла
35+
- [x] Автоматическая перезагрузка узла в случае обнаружения критического состояния
36+
- [x] Отправка сообщений о критическом состоянии узла в Телеграм и/или Дискорд
37+
- [x] Отправка текущего баланса указанного адрес в Телеграм и/или Дискорд
38+
- [x] Отправка стоимости Мины в Телеграм и/или Дискорд
39+
- [x] Отключение snark-worker перед производством блока и последующее возобновление его работы
40+
- [x] Контроль потребления памяти и перезагрузка узла при критическом использовании памяти
3141

3242
#### Программный стек:
3343
- сервер - JavaScript

README.UA.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,39 @@
99
## Основні можливості
1010

1111
**Monitor Client:**
12-
- [x] Display of the main indicators of the Mina network (Block height, uptime, epoch and slot info)
13-
- [x] Displaying the status of the node daemon (SYNCED, CATCHUP, BOOTSTRAP, ...)
14-
- [x] Displaying the health of node (OK, Fork, Hanging)
15-
- [x] Displaying the server resources consumed by the node (CPU, RAM, NETWORK)
16-
- [x] Displaying the balance of the specified address and the value of this balance in different currencies
17-
- [x] Displaying information about delegations to the specified validator address
18-
- [x] Displaying information about blocks won and rewards received in the current era
19-
- [x] Displays general information about the site server
20-
- [x] Convenient live graphs for displaying consumed resources
21-
- [x] Responsive interface (It is comfortable to look at both PC and phone and tablet)
12+
- [x] Відображення основних показників мережі Mina (Block height, uptime, epoch and slot info)
13+
- [x] Відображення стану демона вузла (SYNCED, CATCHUP, BOOTSTRAP, ...)
14+
- [x] Відображення здоров'я вузла (ОК, Fork, Hanging)
15+
- [x] Відображення споживаних вузлом ресурсів сервера (CPU, RAM, NETWORK)
16+
- [x] Відображення балансу зазначеного адресу і вартості цього балансу в різних валютах
17+
- [x] Відображення інформації про делегаціях на вказану адресу валідатора
18+
- [x] Відображення інформації про виграних блоках і отриманому винагороду в поточній епосі
19+
- [x] Відображення загальної інформації про сервер вузла
20+
- [x] Зручні живі графіки для відображення споживаних ресурсів
21+
- [x] Чуйний (responsive) інтерфейс (Комфортно дивитися і на ПК і на телефоні і на планшеті)
22+
23+
**Monitor Cluster:**
24+
- [x] Все, що відображає простий клієнт, плюс
25+
- [x] Відображення стану декількох (до 3-х) вузлів на одній сторінці
26+
- [x] Циклічний обхід вузлів, опитування загальної інформації для адреси здійснюється послідовно з синхронізованих вузлів
27+
- [x] Відображення швидкості відповіді GraphQL вузла на основний запит
28+
29+
> Ви можете знайти `Monitor Cluster` в [цьому репозиторії](https://github.com/olton/mina-monitor-cluster)
2230
2331
**Monitor Server Side:**
24-
- [x] Monitoring node health
25-
- [x] Identification of critical node states (fork, forward fork, node freeze, lag/lead Mina Explorer)
26-
- [x] Determining the Synchronization State of a Node
27-
- [x] Automatic reboot of the node in case of critical state detection
28-
- [x] Sending messages about the critical state of the node in Telegram and/or Discord
29-
- [x] Sending the current balance of the specified address to Telegram and/or Discord
30-
- [x] Sending Mina's cost to Telegram and/or Discord
32+
- [x] Контроль здоров'я вузла
33+
- [x] Визначення критичних станів (форк, випереджаюче форк, зависання вузла, відставання / випередження Mina Explorer)
34+
- [x] Визначення стану синхронізації вузла
35+
- [x] Автоматичне перезавантаження вузла в разі виявлення критичного стану
36+
- [x] Відправлення повідомлень про критичний стан вузла в Telegram та/або Discord
37+
- [x] Відправка поточного балансу зазначеного адреса в Telegram та/або Discord
38+
- [x] Відправка вартості Міни в Telegram та/або Discord
39+
- [x] Відключення snark-worker перед виробництвом блоку і подальше відновлення його роботи
40+
- [x] Контроль споживання пам'яті та перезавантаження вузла при критичному використанні пам'яті
3141

3242
#### Програмний стек:
33-
- сервер - JavaScript
34-
- кліент - JavaScript, HTML, CSS
43+
- сервер - JavaScript (Node JS >= v14)
44+
- клієнт - JavaScript, HTML, CSS
3545

3646
### Використано компоненти
3747
+ [x] [Mina Node Monitor](https://github.com/olton/mina-node-monitor) by [Serhii Pimenov](https://github.com/olton)

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ This is a `client-server` application for visual monitoring of the validator nod
2020
- [x] Convenient live graphs for displaying consumed resources
2121
- [x] Responsive interface (It is comfortable to look at both PC and phone and tablet)
2222

23+
**Cluster Client:**
24+
- [x] Anything that a simple client displays, plus
25+
- [x] Displaying the status of several (up to 3) nodes on one page
26+
- [x] Cyclic bypass of nodes, polling of general information for the address is carried out sequentially from synchronized nodes
27+
- [x] Displaying the response rate of a GraphQL node to the main request
28+
29+
> You can find `Monitor Cluster` in [this repo](https://github.com/olton/mina-monitor-cluster)
30+
2331
**Monitor Server Side:**
2432
- [x] Monitoring node health
2533
- [x] Identification of critical node states (fork, forward fork, node freeze, lag/lead Mina Explorer)
@@ -28,6 +36,9 @@ This is a `client-server` application for visual monitoring of the validator nod
2836
- [x] Sending messages about the critical state of the node in Telegram and/or Discord
2937
- [x] Sending the current balance of the specified address to Telegram and/or Discord
3038
- [x] Sending Mina's cost to Telegram and/or Discord
39+
- [x] Disabling snark-worker before block production and then resuming its work
40+
- [x] Monitor memory consumption and reboot node when memory is critical
41+
3142

3243
#### Monitor built with a stack:
3344
- server - NodeJS, JavaScript

0 commit comments

Comments
 (0)