Skip to content

Commit

Permalink
docs: πŸ“ emphasize health check more
Browse files Browse the repository at this point in the history
  • Loading branch information
heldrida committed Sep 7, 2023
1 parent 9dd3083 commit 4bd1da5
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/node/health-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 4bd1da5

Please sign in to comment.