diff --git a/docs/participate/run-nodes/mytonctrl-status.mdx b/docs/participate/run-nodes/mytonctrl-status.mdx new file mode 100644 index 0000000000..05052e84aa --- /dev/null +++ b/docs/participate/run-nodes/mytonctrl-status.mdx @@ -0,0 +1,157 @@ +# MyTonCtrl status + +Here is an explanation of `status` command output. + +![status](/img/docs/mytonctrl/status.png) + +## TON network status + +### Network name + +Possible values: `mainnet`, `testnet`, `unknown`. `unknown` mustn't be printed ever. + +### Number of validators + +There are two values: one green and one yellow. Green is the number of online validators, yellow is a number of all +validators. +Must be an integer greater than 0, MyTonCtrl get it with command `getconfig 34`, +check [this (param 32-34-and-36) section](/develop/howto/blockchain-configs#param-32-34-and-36) for more. + +### Number of shardchains + +Must be an integer greater than 0, has green color. + +### Number of offers + +There are two values: one green and one yellow. Green is a number of `new offers`, yellow is a number of `all offers`. + +### Number of complaints + +There are two values: one green and one yellow. Green is a number of `new complaints`, yellow is a number +of `all complaints`. + +### Election status + +Can be green text `open` or yellow `closed`. + +## Local validator status + +### Validator Index + +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. + +### Validator efficiency + +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. + +### ADNL address of local validator + +Just ADNL address. + +### Local validator wallet address + +The address used for staking must be a valid TON address. + +### Local validator wallet balance + +The balance of the wallet. + +### Load average + +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. + +### Network load average + +Three integers, same logic as for `load average`: system load average for the last 1, 5 and 15 minutes. + +### Memory load + +Two pairs of integers, absolute and relative memory usage of ram and swap. + +### Disks load average + +Same as for `memory load`, but for all disks. + +### Mytoncore status + +Should be green, tells how much time Mytoncore is up. + +### Local validator status + +Should be green, tells how much time the local validator is up. + +### Local validator out of sync + +Integer should be less than 20 (it will be green so). + +### Local validator last state serialization + +Shows the number of out-of-service masterchain blocks + +### Local validator database size + +The absolute load should be less than 1000 GB, a relative load should be less than 80%. + +### Version mytonctrl + +Hash of commit and name of branch. + +### Version validator + +Hash of commit and name of branch. + +## TON network configuration + +### Configurator address + +Configurator address, check [this param 0](/develop/howto/blockchain-configs#param-0) for more. + +### Elector address + +Elector address, check [this param 1](/develop/howto/blockchain-configs#param-1) for more. + +### Validation period + +Validation period in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more. + +### Duration of elections + +Duration of elections in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more. + +### Hold period + +Hold period in seconds, check [this param 15](/develop/howto/blockchain-configs#param-15) for more. + +### Minimum stake + +Minimum stake in TONs, check [this param 17](/develop/howto/blockchain-configs#param-17) for more. + +### Maximum stake + +Maximum stake in TONs, check [this param 17](/develop/howto/blockchain-configs#param-17) for more. + +## TON timestamps + +### TON Network Launch + +The time when the current network (mainnet or testnet) was launched. + +### Start of the Validation Cycle + +The timestamp for the start of the validation cycle; it will be green if it represents a future moment. + +### End of the Validation Cycle + +The timestamp for the end of the validation cycle; it will be green if it represents a future moment. + +### Start of Elections + +The timestamp for the start of the elections; it will be green if it represents a future moment. + +### End of Elections + +The timestamp for the end of the elections; it will be green if it represents a future moment. + +### Beginning of the Next Elections + +The timestamp for the start of the next elections; it will be green if it represents a future moment. diff --git a/docs/participate/run-nodes/mytonctrl.mdx b/docs/participate/run-nodes/mytonctrl.mdx index f2bccf239a..49cd833773 100644 --- a/docs/participate/run-nodes/mytonctrl.mdx +++ b/docs/participate/run-nodes/mytonctrl.mdx @@ -53,6 +53,8 @@ Get current mytonctrl and node status. Param combinations: | No args | `status` | `status` | Full status report including validator efficiency and online validators. | | Fast | `status fast` | `status fast` | Must be used on TestNet. Status report without validator efficiency and online validators count. | +[See more about status output](/participate/run-nodes/mytonctrl-status) + ### installer No args, run the installer of TON modules (script /usr/src/mytonctrl/mytoninstaller.py) diff --git a/docusaurus.config.js b/docusaurus.config.js index 337d73fddb..19d4dca0a1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -416,6 +416,10 @@ const config = { to: '/participate/network-maintenance/vesting-contract', label: 'Vesting Contract', }, + { + to: '/participate/run-nodes/mytonctrl-status', + label: 'MyTonCtrl Status', + }, { to: '/participate/run-nodes/faq', label: 'FAQ', diff --git a/sidebars.js b/sidebars.js index 2f65774078..ee79596796 100644 --- a/sidebars.js +++ b/sidebars.js @@ -678,6 +678,7 @@ const sidebars = { 'participate/run-nodes/nodes-troubleshooting', 'participate/nodes/node-maintenance-and-security', 'participate/run-nodes/local-ton', + 'participate/run-nodes/mytonctrl-status', 'participate/run-nodes/faq', ], diff --git a/static/img/docs/mytonctrl/status.png b/static/img/docs/mytonctrl/status.png new file mode 100644 index 0000000000..92aa867e70 Binary files /dev/null and b/static/img/docs/mytonctrl/status.png differ