> For the complete documentation index, see [llms.txt](https://docs.forestall.io/fsprotect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.forestall.io/fsprotect/health-check.md).

# Health Check

The Health Check page displays real-time status of key components and system usage metrics, allowing quick monitoring of system health and resource utilization.

<figure><img src="https://3408039743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FObpV44hoVkNmo5bFuVVL%2Fuploads%2Fgit-blob-41dd805a88454ed6602c358dd1895242d99932fb%2Fhealth-check-image-1.png?alt=media" alt=""><figcaption></figcaption></figure>

## API

The **API** section provides a real-time status of the API services, showing whether they are currently running and accessible. It includes:

* **Status**: Displays if the API services are active and functioning.
* **URL**: Provides the direct link to access the API, ensuring connectivity for client requests.
* **PostgreSQL Database**: Indicates the operational status of the PostgreSQL database, essential for data storage and retrieval.
* **Neo4j Graph Database**: Displays the status of the Neo4j graph database, which supports complex relationships and queries within the data structure.

<figure><img src="https://3408039743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FObpV44hoVkNmo5bFuVVL%2Fuploads%2Fgit-blob-73172adaa2c266ccc2257d9311ec0d0c22fd8c6a%2Fhealth-check-image-2.png?alt=media" alt=""><figcaption></figcaption></figure>

## Core

The Core section monitors the core application’s underlying infrastructure and services, detailing:

* **Status**: Shows if the core services are up and running.
* **URL**: Lists the URL endpoint for the core service, which is vital for backend processes.
* **PostgreSQL Database**: Reflects the status of the core’s connection to PostgreSQL, enabling reliable data management.
* **Neo4j Graph Database**: Shows the connectivity to the Neo4j graph database, supporting the application’s relationship-driven data needs.
* **HangFire Service**: Displays the operational status of HangFire, responsible for handling background job processing and scheduling.

<figure><img src="https://3408039743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FObpV44hoVkNmo5bFuVVL%2Fuploads%2Fgit-blob-eca4cfcfd571e720cc2e922b65c1504562b2b1fa%2Fhealth-check-image-3.png?alt=media" alt=""><figcaption></figcaption></figure>

## System Usage

The System Usage section provides insights into resource consumption, helping monitor and manage system performance:

* **CPU Usage**: Displays the current CPU load, indicating how much processing power is in use.
* **Memory Usage**: Shows memory utilization, helping track whether available memory is sufficient for operations.
* **Disk Usage**: Indicates disk storage consumption, highlighting free and used space to prevent storage overload.
* **Path**: Specifies the directory path where the application is stored, useful for file management.
* **Version**: Displays the current version of the FsProtect, allowing for version tracking and updates.

<figure><img src="https://3408039743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FObpV44hoVkNmo5bFuVVL%2Fuploads%2Fgit-blob-970bc3927f6ac9ea1ddba90b6a6edbfa918c3498%2Fhealth-check-image-4.png?alt=media" alt=""><figcaption></figcaption></figure>
