Autonomys monitoring powershell script

A simple to run and lightweight powershell script that captures live information using prometheus metrics endpoint.

To use the monitor:

• save all files from latest monitor release in a folder on local computer
• copy contents of sample-config.txt to a new file and save it in the same folder. Name the new file as config.txt
• adjust config.txt to match your node, farmer and (optional) cluster set-up [refer to Requirements: section below]
• run subspace_advanced_CLI_monitor.ps1 file in powershell

Note: If you recently restarted Farmer please wait for few minutes and the metrics will show eventually

• Tip: Validate prometheus-listen-on endpoints defined in node & farmer start-up files are working correctly, use a web browser and check data is populated at endpoints - http://node-local-ip:port/metrics & http://farmer-local-ip:port/metrics

Requirements:

• must use latest CLI release (see https://github.com/autonomys/subspace/releases)
• powershell is installed (Windows should have powershell pre-installed. For installing powershell on linux see https://learn.microsoft.com/en-us/powershell/scripting/install/install-ubuntu?view=powershell-7.4)
• add --prometheus-listen-on [node-local-ip:port] to node start-up script
• add --prometheus-listen-on [farmer-local-ip:port] to farmer start-up script
• change node/farmer settings in the config.txt file so that the ip:port are matching to the values set for --prometheus-listen-on your node and farmer

If using cluster, apply additional settings as below:

• add command line options -m and -n to nats-server start-up script (example: nats-server -n my-nats-server1 -m 18080 -c nats.config)
• change nats-server settings in the config.txt file so that the ip matches to the computer running nats-server and port matches to 'http listener port' as in option scpecified for -m in the nats-server start-up script

To enable web access, do the following:

• enable api in config file
• ensure to create an inbound rule under windows defender firewall for http listening port as specified in the config file. This must be done on the computer that hosts ps1 script
• must run the ps1 file as admin in powershell console
• the endpoint to use is http://ip:port/summary
• 

Key features:

• monitoring support for multi component (remote or local) nodes, farmer and (optional) cluster set-up, using prometheus metrics endpoints
• monitor script can run independently on a pc separate from cluster/farms/nodes hosted pc
• multi OS (Windows and Linux) support for running the monitoring tool
• web service enabled to view stats using a web browser on phone/ pc or as a second screen to legacy monitor console display
• run-time changes to config.txt reflected in monitor
• customizable alerts enabled for discord and telegram
• Configurable summary and detail stats view at start-up
• local Time Zone display

*** For questions and feedback please contact (rs_00) in autonomys discord channel.