Add basic healthcheck command (#15)

Author: hsoerensen

README.md

@@ -155,6 +155,20 @@ Open a bash shell in the AVM container with the following command:
 ~/voi/bin/start-shell
 ```
 
+### Getting basic node status
+
+To retrieve basic health information about your node, execute the following command:
+
+```bash
+~/voi/bin/get-node-status
+```
+
+The `get-node-status` command performs checks using:
+
+- `goal node status` to connect to the running daemon and retrieve basic node information
+- `/health`: This API endpoint checks the reported health of the node. [REST API /health documentation](https://developer.algorand.org/docs/rest-apis/algod/#get-health).
+- `/ready`: This API endpoint checks the reported readiness of the node and if fully caught up. [REST API /ready documentation](https://developer.algorand.org/docs/rest-apis/algod/#get-ready).
+
 ## Debugging
 
 ### Startup state for services in stack

bin/create-account

@@ -5,4 +5,5 @@ if [ -z "${container_id}" ]; then
     echo "AVM container is not running. Please start it first."
     exit 1
 fi
+
 docker exec -it "${container_id}" goal account new

bin/get-account-mnemonic

@@ -11,4 +11,5 @@ if [ -z "$1" ]; then
     echo "Example: get-account-mnemonic <account_address>"
     exit 1
 fi
+
 docker exec -e account_addr="$1" -it "${container_id}" bash -c 'goal account export -a $account_addr'

bin/get-node-status

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+container_id=$(docker ps -q -f name=voinetwork_algod)
+if [ -z "${container_id}" ]; then
+    echo "AVM container is not running. Please start it first."
+    exit 1
+fi
+
+declare -A health_checks
+
+if [[ $(docker exec -it "${container_id}" bash -c "goal node status") ]]; then
+    health_checks["Daemon running"]="true"
+else
+    health_checks["Daemon running"]="false"
+fi
+
+if [[ $(docker exec "${container_id}" bash -c "curl -fs http://localhost:8080/health") ]]; then
+    health_checks["Daemon healthy"]="true"
+else
+    health_checks["Daemon healthy"]="false"
+fi
+
+if [[ $(docker exec "${container_id}" bash -c "curl -fs http://localhost:8080/ready") ]]; then
+    health_checks["Daemon ready (and caught up)"]="true"
+else
+    health_checks["Daemon ready (and caught up)"]="false"
+fi
+
+# Print all health checks
+echo "Health checks:"
+echo "**************"
+for check in "${!health_checks[@]}"; do
+  echo "$check: ${health_checks[$check]}"
+done

bin/import-account

@@ -5,4 +5,5 @@ if [ -z "${container_id}" ]; then
     echo "AVM container is not running. Please start it first."
     exit 1
 fi
+
 docker exec -it "${container_id}" goal account import

bin/set-telemetry-name

@@ -31,4 +31,4 @@ set_telemetry_name
 
 bash -c "env VOINETWORK_TELEMETRY_NAME=$VOINETWORK_TELEMETRY_NAME docker stack deploy -c ../docker-swarm/compose.yml voinetwork"
 
-echo "Changes have been applied to the network. Please wait a minute for the changes to take effect."
+echo "Changes has been applied to the network. Please wait a minute for the changes to take effect."