From 416bb3249d89056d49aebafb1488ad7687294cb1 Mon Sep 17 00:00:00 2001 From: Srayman <42743016+Srayman@users.noreply.github.com> Date: Sun, 15 Sep 2019 22:36:35 -0400 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8a21df9..c980e0e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Python scripts to record Nanocurrency node stats - used by https://nano-faucet.o - Active Confirmation Count - Confirmation Height Processor Count - Active Difficulty Multiplier +- Several other stats ... # Install These scripts use the requests library as well as a few others. Install any missing libraries @@ -16,25 +17,25 @@ These scripts use the requests library as well as a few others. Install any miss # Config `config.py.sample` can be renamed to config.py and provides several options for customizing automatic uploads to https://nano-faucet.org/beta/chart and other settings primarily for vote_analysis.py. -# Warning - Use Ctrl-C only once to quit. It may take a few seconds to end the loops and write to disk before closing. +## Warning - Use Ctrl-C only once to quit. It may take a few seconds to end the loops and write to disk before closing. -# Usage - Confirmation History -Confirmation History is pulled from the confirmation_history RPC. The script by default runs every 10 seconds and saves to a file every 60 seconds. The file save amount should be in multiples of the RPC delay. The process will save to a file with the date in the filename (eg. confirmation_history_2019-06-29.json). +# Usage - Node Stats +Node Stats will collect other statistical measures to help with plotting the node performance. The script by default checks every 15 seconds and saves to a file every 60 seconds. The file save amount should be in multiples of the RPC delay. The process will save to a file with the date in the filename (eg. stats_2019-06-29.json). It will read the contents of any file that matches the filename and combine the results for that day. -After quiting the execution (eg. Ctrl-C) it will save the current run to confirmation_history.json. When the script is started again it will automatically rename confirmation_history.json to include the timestamp at the end to preserve prior attempts. +After quiting the execution (eg. Ctrl-C) it will save the current run to stats.json. When the script is started again it will automatically rename confirmation_history.json to include the timestamp at the end to preserve prior attempts. -`python confirmation_history.py` +`python node_stats.py` -# Usage - Node Stats -Node Stats will collect other statistical measures to help with plotting the node performance. The script by default checks every 15 seconds and saves to a file every 60 seconds. The file save amount should be in multiples of the RPC delay. The process will save to a file with the date in the filename (eg. stats_2019-06-29.json). +# Usage - Confirmation History +Confirmation History is pulled from the confirmation_history RPC. The script by default runs every 10 seconds and saves to a file every 60 seconds. The file save amount should be in multiples of the RPC delay. The process will save to a file with the date in the filename (eg. confirmation_history_2019-06-29.json). It will read the contents of any file that matches the filename and combine the results for that day. -After quiting the execution (eg. Ctrl-C) it will save the current run to stats.json. When the script is started again it will automatically rename confirmation_history.json to include the timestamp at the end to preserve prior attempts. +After quiting the execution (eg. Ctrl-C) it will save the current run to confirmation_history.json. When the script is started again it will automatically rename confirmation_history.json to include the timestamp at the end to preserve prior attempts. -`python node_stats.py` +`python confirmation_history.py` # Usage - Vote Analysis Vote Analysis will connect to the nodes websocket to record votes and confirmations for designated accounts. This is used to analyze timing of votes, number of votes per rep and how many votes a particular block received. It will generate 4 files when closed.