From 4bd1da5d956120c23a70d7e5406e011dcb3c20e5 Mon Sep 17 00:00:00 2001 From: Helder Oliveira Date: Thu, 7 Sep 2023 14:38:52 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20emphasize=20health=20che?= =?UTF-8?q?ck=20more?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/node/health-check.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/node/health-check.md b/docs/node/health-check.md index 3769bcde0..c6b6410b2 100644 --- a/docs/node/health-check.md +++ b/docs/node/health-check.md @@ -15,7 +15,13 @@ import Author from '@site/src/components/Author'; ## Overview -In network applications, a health check is a process of verifying the overall health and availability of a service. It usually involves sending a request to a specific endpoint of a service and receiving a response indicating the status. The response includes information about the status of the service, node or any errors or warnings if not healthy. This helps developers, node operators, and system administrators identify and resolve issues that may affect the network, node performance and availability. +In network applications, a health check is a process of verifying the overall health and availability of a service. It usually involves sending a request to a specific endpoint of a service and receiving a response indicating the status. The response includes information about the status of the service, or any errors or warnings if not healthy. This helps developers, node operators, and system administrators identify and resolve issues that may affect the network, node performance and availability. + +A Node operator or system administrator can communicate with the node to confirm the status at any time. + +:::tip +We're using cURL, for the examples, thus make sure that you have it installed on your operating system. +::: ## Quick health check @@ -46,10 +52,6 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ }' http://127.0.0.1:4069/rpc/v0 ``` -:::tip -We're using cURL, make sure that you have it installed otherwise install it in your operating system. -::: - If the request is successful, you should get the result `pong` as follows: ```sh