Kgis-server-monitor NPM

KGIS-Server Monitor

Server Monitor is a Node.js package for real-time monitoring of server health using WebSocket, including CPU usage, memory usage, and database status checks.

Installation

You can install Server Monitor via npm:

npm install kgis-server-monitor

Usage

Setting Up Server Monitor

To use Server Monitor in your Node.js application, follow these steps:

Import Server Monitor:
const { startServerMonitor } = require('kgis-server-monitor');
Start the WebSocket Server:

const app = express(); // If user use express framework

const app = await NestFactory.create(AppModule); // If user use Nest framework


const config = {
  server: app, // Existing app server instance
  mongoUri: 'mongodb://localhost:27017/mydb',// MongoDB URI (optional)
  sqlConfig: { // MySQL configuration (optional)
    host: '<host>',
    user: '<user_name>>',
    password: '<password>',
    database: '<data_base_name>'
  },
  rabbitUrl:'amqp://user:user@localhost:5672' // RabbitMQ URI (optional)
};

startServerMonitor(config);

Features

Real-time Monitoring: Provides real-time updates of CPU usage, memory usage, , database status and RabbitMQ.
WebSocket Communication: Uses WebSocket for efficient and low-latency communication.

API Reference

`startServerMonitor(options)`

Starts the WebSocket server for monitoring server health.

Options:
- server (string): Existing app server instance.
- mongoUri (string, optional): MongoDB URI for database monitoring.
- sqlConfig (object, optional): MySQL configuration object for database monitoring.
- rabbitUrl (string, optional): Rabbit URI for database monitoring.