Add documentation and full_node ports endpoint (#68)

Author: Starttoaster

internal/healthcheck/fullnode.go

@@ -86,3 +86,10 @@ func (h *Healthcheck) fullNodeLiveness() func(http.ResponseWriter, *http.Request
 		timeMetricHealthcheckHelper(h.lastHeightTime, w, r)
 	}
 }
+
+// Ports endpoint will be successful when the full node peer and RPC ports are listening on the host
+func (h *Healthcheck) fullNodePorts() func(http.ResponseWriter, *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		timeMetricHealthcheckHelper(h.lastFullNodeActivity, w, r)
+	}
+}

internal/healthcheck/healthcheck.go

@@ -94,6 +94,7 @@ func (h *Healthcheck) StartServer() error {
 	http.HandleFunc("/full_node/startup", h.fullNodeStartup())
 	http.HandleFunc("/full_node/readiness", h.fullNodeReadiness())
 	http.HandleFunc("/full_node/liveness", h.fullNodeLiveness())
+	http.HandleFunc("/full_node/ports", h.fullNodePorts())
 	http.HandleFunc("/seeder", h.seederHealthcheck())
 	http.HandleFunc("/seeder/readiness", h.seederReadiness())
 	http.HandleFunc("/timelord", h.timelordHealthcheck())

readme.md

@@ -59,3 +59,19 @@ To use a config file, create a new yaml file and place any configuration options
 ```yaml
 healthcheck-port: 9950
 ```
+
+## Healthcheck Endpoints
+
+This is the comprehensive list of endpoints currently available for Chia healthchecking purposes by this service.
+
+* `/full_node` - Checks that the local full_node sync height is increasing.
+* `/full_node/startup` - Checks that the local full_node sync height is increasing.
+* `/full_node/liveness` - Checks that the local full_node sync height is increasing.
+* `/full_node/readiness` - Checks that the local full_node is synced to the full chain.
+* `/full_node/ports` - Checks that the full_node peer and RPC ports are bound.
+* `/seeder` - Checks the local seeder and ensures the resolver responds with at least one peer IP address.
+* `/seeder/readiness` - Checks the local seeder and ensures the resolver responds.
+* `/timelord` - Checks the local timelord and ensures it is finishing proofs of time.
+* `/timelord/readiness` - Checks the local timelord and ensures it is finishing proofs of time.
+
+Other Chia components and endpoints may be added to this list over time.