Skip to content

Commit 14a545a

Browse files
pixelplexFull-Hat
andauthored
Add status output explanation (#728)
Co-authored-by: Full-Hat <nikita3131228@gmail.com> Co-authored-by: Full-Hat <68519677+Full-Hat@users.noreply.github.com>
1 parent a2c51b6 commit 14a545a

File tree

5 files changed

+164
-0
lines changed

5 files changed

+164
-0
lines changed
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# MyTonCtrl status
2+
3+
Here is an explanation of `status` command output.
4+
5+
![status](/img/docs/mytonctrl/status.png)
6+
7+
## TON network status
8+
9+
### Network name
10+
11+
Possible values: `mainnet`, `testnet`, `unknown`. `unknown` mustn't be printed ever.
12+
13+
### Number of validators
14+
15+
There are two values: one green and one yellow. Green is the number of online validators, yellow is a number of all
16+
validators.
17+
Must be an integer greater than 0, MyTonCtrl get it with command `getconfig 34`,
18+
check [this (param 32-34-and-36) section](/develop/howto/blockchain-configs#param-32-34-and-36) for more.
19+
20+
### Number of shardchains
21+
22+
Must be an integer greater than 0, has green color.
23+
24+
### Number of offers
25+
26+
There are two values: one green and one yellow. Green is a number of `new offers`, yellow is a number of `all offers`.
27+
28+
### Number of complaints
29+
30+
There are two values: one green and one yellow. Green is a number of `new complaints`, yellow is a number
31+
of `all complaints`.
32+
33+
### Election status
34+
35+
Can be green text `open` or yellow `closed`.
36+
37+
## Local validator status
38+
39+
### Validator Index
40+
41+
If the validator index is higher or equal to 0 (and it should be so if validator mode is active), it must be green, else - red.
42+
43+
### Validator efficiency
44+
45+
Can be `n/a` or a number from `0 to 100`. In range from `0 to 10` or if it is `n/a` - it's colored red, else red.
46+
47+
### ADNL address of local validator
48+
49+
Just ADNL address.
50+
51+
### Local validator wallet address
52+
53+
The address used for staking must be a valid TON address.
54+
55+
### Local validator wallet balance
56+
57+
The balance of the wallet.
58+
59+
### Load average
60+
61+
Has format `[int]: int, int, int`. First one is a number of cpus, others represent the system load average for the last 1, 5 and 15 minutes.
62+
63+
### Network load average
64+
65+
Three integers, same logic as for `load average`: system load average for the last 1, 5 and 15 minutes.
66+
67+
### Memory load
68+
69+
Two pairs of integers, absolute and relative memory usage of ram and swap.
70+
71+
### Disks load average
72+
73+
Same as for `memory load`, but for all disks.
74+
75+
### Mytoncore status
76+
77+
Should be green, tells how much time Mytoncore is up.
78+
79+
### Local validator status
80+
81+
Should be green, tells how much time the local validator is up.
82+
83+
### Local validator out of sync
84+
85+
Integer should be less than 20 (it will be green so).
86+
87+
### Local validator last state serialization
88+
89+
Shows the number of out-of-service masterchain blocks
90+
91+
### Local validator database size
92+
93+
The absolute load should be less than 1000 GB, a relative load should be less than 80%.
94+
95+
### Version mytonctrl
96+
97+
Hash of commit and name of branch.
98+
99+
### Version validator
100+
101+
Hash of commit and name of branch.
102+
103+
## TON network configuration
104+
105+
### Configurator address
106+
107+
Configurator address, check [this param 0](/develop/howto/blockchain-configs#param-0) for more.
108+
109+
### Elector address
110+
111+
Elector address, check [this param 1](/develop/howto/blockchain-configs#param-1) for more.
112+
113+
### Validation period
114+
115+
Validation period in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more.
116+
117+
### Duration of elections
118+
119+
Duration of elections in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more.
120+
121+
### Hold period
122+
123+
Hold period in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more.
124+
125+
### Minimum stake
126+
127+
Minimum stake in TONs, check [this param 17](/develop/howto/blockchain-configs#param-17) for more.
128+
129+
### Maximum stake
130+
131+
Maximum stake in TONs, check [this param 17](/develop/howto/blockchain-configs#param-17) for more.
132+
133+
## TON timestamps
134+
135+
### TON Network Launch
136+
137+
The time when the current network (mainnet or testnet) was launched.
138+
139+
### Start of the Validation Cycle
140+
141+
The timestamp for the start of the validation cycle; it will be green if it represents a future moment.
142+
143+
### End of the Validation Cycle
144+
145+
The timestamp for the end of the validation cycle; it will be green if it represents a future moment.
146+
147+
### Start of Elections
148+
149+
The timestamp for the start of the elections; it will be green if it represents a future moment.
150+
151+
### End of Elections
152+
153+
The timestamp for the end of the elections; it will be green if it represents a future moment.
154+
155+
### Beginning of the Next Elections
156+
157+
The timestamp for the start of the next elections; it will be green if it represents a future moment.

docs/participate/run-nodes/mytonctrl.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ Get current mytonctrl and node status. Param combinations:
5353
| No args | `status` | `status` | Full status report including validator efficiency and online validators. |
5454
| Fast | `status fast` | `status fast` | Must be used on TestNet. Status report without validator efficiency and online validators count. |
5555

56+
[See more about status output](/participate/run-nodes/mytonctrl-status)
57+
5658
### installer
5759

5860
No args, run the installer of TON modules (script /usr/src/mytonctrl/mytoninstaller.py)

docusaurus.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,10 @@ const config = {
416416
to: '/participate/network-maintenance/vesting-contract',
417417
label: 'Vesting Contract',
418418
},
419+
{
420+
to: '/participate/run-nodes/mytonctrl-status',
421+
label: 'MyTonCtrl Status',
422+
},
419423
{
420424
to: '/participate/run-nodes/faq',
421425
label: 'FAQ',

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,6 +678,7 @@ const sidebars = {
678678
'participate/run-nodes/nodes-troubleshooting',
679679
'participate/nodes/node-maintenance-and-security',
680680
'participate/run-nodes/local-ton',
681+
'participate/run-nodes/mytonctrl-status',
681682
'participate/run-nodes/faq',
682683

683684
],

static/img/docs/mytonctrl/status.png

361 KB
Loading

0 commit comments

Comments
 (0)