server-health-checker
v1.0.1
Published
This project monitors server health by checking CPU usage, memory usage, and disk space. It displays the health check results in the console and sends an alert using the souq-error-handler package if any of the health checks enter the red zone.
Downloads
3
Readme
Server Health Checker
This project monitors server health by checking CPU usage, memory usage, and disk space. It displays the health check results in the console and sends an alert using the souq-error-handler package if any of the health checks enter the red zone.
Usage
To use the Server Health Checker in your project, first install it as a dependency:
npm install --save server-health-checker
Then, import and use the Server Health Checker in your project:
const ServerHealthChecker = require("server-health-checker");
// Initialize ServerHealthChecker instance
const checker = new ServerHealthChecker(intervalInSeconds, logToConsole /*true or false*/);
// Start monitoring server health
checker.startMonitoring();
Parameters
intervalInSeconds (number): The interval in seconds between server health checks.
logToConsole (boolean, optional, default: true): Whether to display server health check results in the console. Pass false to disable console logs.
Example Usage
- Using Server Health Checker with console logs enabled (default behavior):
const ServerHealthChecker = require("server-health-checker");
const checker = new ServerHealthChecker(60); // Check server health every 60 seconds
checker.startMonitoring();
- Using Server Health Checker with console logs disabled:
const ServerHealthChecker = require("server-health-checker");
const checker = new ServerHealthChecker(60, false); // Check server health every 60 seconds without console logs
checker.startMonitoring();