pms_md 1.0.0 → 1.0.3

package/README.md

@@ -1,93 +1,618 @@
-# PMS_MD
+# 🚀 PMS_MD - Comprehensive Node.js Monitoring Solution
 
+[![npm version](https://img.shields.io/badge/npm-1.0.3-blue.svg)](https://www.npmjs.com/package/pms_md)
+[![License: ISC](https://img.shields.io/badge/License-ISC-green.svg)](LICENSE)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen.svg)](https://nodejs.org/)
 
+**Production-ready monitoring solution for Node.js applications with comprehensive database support, error tracking, health checks, and multi-channel notifications.**
 
-## Getting started
+---
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## ✨ Features
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+- 🗄️ **13+ Database Support** - MongoDB, PostgreSQL, MySQL, MariaDB, MSSQL, SQLite, Redis, Cassandra, Elasticsearch, DynamoDB, Neo4j, CouchDB, Sequelize
+- 📧 **Email Notifications** - Automatic alerts for errors, crashes, and database failures
+- 📊 **Health Monitoring** - System resources (CPU, Memory), API errors, database connections
+- 🔔 **Multi-Channel Alerts** - Email, Slack, and custom webhooks
+- 📝 **Advanced Logging** - Winston-based logging with daily rotation and sanitization
+- 🛡️ **Graceful Shutdown** - Proper cleanup with email notifications on server shutdown
+- 🎯 **Express Integration** - Middleware for error handling, request logging, and health endpoints
+- 📈 **Metrics & Analytics** - Historical metrics tracking and dashboard endpoints
 
-## Add your files
+---
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+## 📦 Installation
 
+```bash
+npm install pms_md
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/manish-proses/pms_md.git
-git branch -M main
-git push -uf origin main
+
+### Optional Database Drivers
+
+Install only the database drivers you need:
+
+```bash
+# SQL Databases
+npm install pg                          # PostgreSQL
+npm install mysql2                      # MySQL
+npm install mariadb                     # MariaDB
+npm install mssql                       # MSSQL (SQL Server)
+npm install sqlite3                     # SQLite
+
+# NoSQL Databases
+npm install mongoose                    # MongoDB
+npm install nano                        # CouchDB
+npm install cassandra-driver            # Cassandra
+
+# Cache & Search
+npm install ioredis                     # Redis
+npm install @elastic/elasticsearch     # Elasticsearch
+
+# Cloud Databases
+npm install @aws-sdk/client-dynamodb    # DynamoDB
+
+# Graph Databases
+npm install neo4j-driver                # Neo4j
+
+# ORM
+npm install sequelize                   # Sequelize (MySQL, PostgreSQL, SQLite, MSSQL)
+```
+
+---
+
+## 🚀 Quick Start
+
+### Basic Setup
+
+```javascript
+const express = require('express');
+const NodeMonitor = require('pms_md');
+
+const app = express();
+
+// Initialize monitor
+const monitor = new NodeMonitor({
+  app: {
+    name: 'my-app',
+    environment: 'production'
+  },
+  notifications: {
+    email: {
+      enabled: true,
+      smtp: {
+        host: 'smtp.gmail.com',
+        port: 587,
+        secure: false,
+        auth: {
+          user: process.env.EMAIL_USER,
+          pass: process.env.EMAIL_APP_PASSWORD
+        }
+      },
+      from: process.env.EMAIL_USER,
+      recipients: ['admin@example.com']
+    }
+  }
+});
+
+// Add middleware
+app.use(monitor.requestLogger());
+app.use(monitor.errorMiddleware());
+
+// Health endpoints
+app.get('/health', monitor.healthCheckEndpoint());
+app.get('/health/info', monitor.healthInfoEndpoint());
+
+// Start monitoring
+monitor.start();
+
+// Start server
+const server = app.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+
+// Graceful shutdown with email notifications
+monitor.setupGracefulShutdown(server);
+
+module.exports = app;
+```
+
+---
+
+## 🗄️ Database Monitoring
+
+### MSSQL (SQL Server)
+
+```javascript
+const sql = require('mssql');
+
+const pool = await sql.connect({
+  server: 'localhost',
+  database: 'mydb',
+  user: 'sa',
+  password: 'password',
+  options: {
+    encrypt: true,
+    trustServerCertificate: true
+  }
+});
+
+monitor.registerDatabase('mssql', 'mssql', pool);
+```
+
+### PostgreSQL
+
+```javascript
+const { Pool } = require('pg');
+
+const pool = new Pool({
+  host: 'localhost',
+  database: 'mydb',
+  user: 'postgres',
+  password: 'password'
+});
+
+monitor.registerDatabase('postgres', 'postgresql', pool);
+```
+
+### MySQL / MariaDB
+
+```javascript
+const mysql = require('mysql2/promise');
+
+const pool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: 'password',
+  database: 'mydb'
+});
+
+monitor.registerDatabase('mysql', 'mysql2', pool);
+```
+
+
+### MongoDB
+
+```javascript
+const mongoose = require('mongoose');
+
+await mongoose.connect('mongodb://localhost:27017/mydb');
+monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
+```
+
+### Redis
+
+```javascript
+const Redis = require('ioredis');
+
+const redis = new Redis({
+  host: 'localhost',
+  port: 6379
+});
+
+monitor.registerDatabase('redis', 'redis', redis);
+```
+
+### SQLite
+
+```javascript
+const sqlite3 = require('sqlite3');
+const db = new sqlite3.Database('./mydb.sqlite');
+
+monitor.registerDatabase('sqlite', 'sqlite', db);
+```
+
+### Cassandra
+
+```javascript
+const cassandra = require('cassandra-driver');
+
+const client = new cassandra.Client({
+  contactPoints: ['localhost'],
+  localDataCenter: 'datacenter1'
+});
+
+await client.connect();
+monitor.registerDatabase('cassandra', 'cassandra', client);
+```
+
+**[See complete database guide →](DATABASE_SUPPORT.md)**
+
+---
+
+## 📊 Supported Databases
+
+| Database | Type | Package | Status |
+|----------|------|---------|--------|
+| MongoDB | NoSQL | `mongoose` | ✅ |
+| PostgreSQL | SQL | `pg` | ✅ |
+| MySQL | SQL | `mysql2` | ✅ |
+| MariaDB | SQL | `mariadb` | ✅ |
+| MSSQL | SQL | `mssql` | ✅ |
+| SQLite | SQL | `sqlite3` | ✅ |
+| Redis | Cache | `ioredis` | ✅ |
+| CouchDB | NoSQL | `nano` | ✅ |
+| Cassandra | NoSQL | `cassandra-driver` | ✅ |
+| Elasticsearch | Search | `@elastic/elasticsearch` | ✅ |
+| DynamoDB | Cloud | `@aws-sdk/client-dynamodb` | ✅ |
+| Neo4j | Graph | `neo4j-driver` | ✅ |
+| Sequelize | ORM | `sequelize` | ✅ |
+
+---
+
+## 📧 Email Notifications
+
+### Gmail Setup
+
+1. Enable 2-Step Verification in your Google Account
+2. Generate App Password: https://myaccount.google.com/apppasswords
+3. Configure environment variables:
+
+```bash
+EMAIL_USER=your-email@gmail.com
+EMAIL_APP_PASSWORD=your-16-char-app-password
+```
+
+### Configuration
+
+```javascript
+const monitor = new NodeMonitor({
+  notifications: {
+    email: {
+      enabled: true,
+      smtp: {
+        host: 'smtp.gmail.com',
+        port: 587,
+        secure: false,
+        auth: {
+          user: process.env.EMAIL_USER,
+          pass: process.env.EMAIL_APP_PASSWORD
+        }
+      },
+      from: process.env.EMAIL_USER,
+      recipients: ['admin@example.com', 'team@example.com']
+    }
+  }
+});
+```
+
+### Notification Types
+
+- ✅ **Server Errors** - Uncaught exceptions and unhandled rejections
+- ✅ **Database Failures** - Connection loss and recovery
+- ✅ **Graceful Shutdown** - Server shutdown notifications
+- ✅ **API Errors** - HTTP 500 errors and critical failures
+
+---
+
+## 🎯 Express Middleware
+
+### Error Handling
+
+```javascript
+// Automatic error tracking and email notifications
+app.use(monitor.errorMiddleware());
+```
+
+### Request Logging
+
+```javascript
+// Log all HTTP requests with sanitization
+app.use(monitor.requestLogger());
+```
+
+### 404 Handler
+
+```javascript
+// Handle 404 errors
+app.use(monitor.notFoundHandler());
+```
+
+---
+
+## 📈 Health Endpoints
+
+### Basic Health Check
+
+```javascript
+app.get('/health', monitor.healthCheckEndpoint());
+```
+
+**Response:**
+```json
+{
+  "status": "healthy",
+  "timestamp": "2025-11-17T12:00:00.000Z",
+  "uptime": 3600,
+  "databases": {
+    "mssql": "connected",
+    "redis": "connected"
+  }
+}
+```
+
+### Detailed Health Info
+
+```javascript
+app.get('/health/info', monitor.healthInfoEndpoint());
+```
+
+**Response:**
+```json
+{
+  "status": "healthy",
+  "timestamp": "2025-11-17T12:00:00.000Z",
+  "uptime": 3600,
+  "system": {
+    "cpu": 45.2,
+    "memory": {
+      "used": 512,
+      "total": 8192,
+      "percentage": 6.25
+    }
+  },
+  "databases": {
+    "mssql": {
+      "status": "connected",
+      "type": "mssql",
+      "version": "Microsoft SQL Server 2019...",
+      "connections": 10
+    }
+  }
+}
+```
+
+
+---
+
+## 🛡️ Graceful Shutdown
+
+Automatically send email notifications when your server shuts down:
+
+```javascript
+const server = app.listen(3000);
+
+// Setup graceful shutdown with email notifications
+monitor.setupGracefulShutdown(server);
+```
+
+**Features:**
+- ✅ Sends email notification on shutdown
+- ✅ Closes all database connections
+- ✅ Stops all monitoring intervals
+- ✅ Handles SIGTERM and SIGINT signals
+- ✅ Prevents memory leaks
+
+---
+
+## 📝 Advanced Configuration
+
+### Full Configuration Example
+
+```javascript
+const monitor = new NodeMonitor({
+  app: {
+    name: 'my-production-app',
+    environment: 'production',
+    version: '1.0.0'
+  },
+  monitoring: {
+    enabled: true,
+    interval: 60000,  // Check every 60 seconds
+    systemMetrics: true,
+    apiErrors: true
+  },
+  database: {
+    enabled: true,
+    checkInterval: 30000,  // Check every 30 seconds
+    queryTimeout: 5000,
+    consecutiveFailuresThreshold: 3
+  },
+  notifications: {
+    email: {
+      enabled: true,
+      smtp: {
+        host: 'smtp.gmail.com',
+        port: 587,
+        secure: false,
+        auth: {
+          user: process.env.EMAIL_USER,
+          pass: process.env.EMAIL_APP_PASSWORD
+        }
+      },
+      from: process.env.EMAIL_USER,
+      recipients: ['admin@example.com']
+    },
+    slack: {
+      enabled: false,
+      webhookUrl: process.env.SLACK_WEBHOOK_URL
+    }
+  },
+  logging: {
+    level: 'info',
+    directory: './logs',
+    maxFiles: '14d',
+    maxSize: '20m',
+    sanitize: true
+  }
+});
 ```
 
-## Integrate with your tools
+---
+
+## 📚 API Reference
+
+### Core Methods
+
+#### `monitor.start()`
+Start all monitoring services.
+
+#### `monitor.stop()`
+Stop all monitoring services.
+
+#### `monitor.registerDatabase(name, type, connection)`
+Register a database for monitoring.
+
+**Parameters:**
+- `name` (string) - Unique identifier for the database
+- `type` (string) - Database type (e.g., 'mssql', 'postgresql', 'mongodb')
+- `connection` (object) - Database connection object
+
+#### `monitor.getDatabaseStats(name)`
+Get statistics for a specific database.
+
+**Returns:** Promise<object>
+
+#### `monitor.getAllDatabaseStats()`
+Get statistics for all registered databases.
+
+**Returns:** Promise<object>
+
+#### `monitor.setupGracefulShutdown(server)`
+Setup graceful shutdown with email notifications.
+
+**Parameters:**
+- `server` (object) - HTTP server instance
+
+### Middleware Methods
+
+#### `monitor.errorMiddleware()`
+Express middleware for error handling.
+
+#### `monitor.requestLogger()`
+Express middleware for request logging.
+
+#### `monitor.notFoundHandler()`
+Express middleware for 404 errors.
+
+### Endpoint Methods
+
+#### `monitor.healthCheckEndpoint()`
+Express endpoint handler for basic health check.
+
+#### `monitor.healthInfoEndpoint()`
+Express endpoint handler for detailed health information.
+
+#### `monitor.dashboardEndpoint()`
+Express endpoint handler for monitoring dashboard.
+
+---
+
+## 🧪 Testing
+
+Run the comprehensive test suite:
+
+```bash
+node test-all-databases.js
+```
+
+**Test Coverage:**
+- ✅ Package loading
+- ✅ Monitor instantiation
+- ✅ Database registration (all 13+ types)
+- ✅ Health checks
+- ✅ Statistics retrieval
+- ✅ Peer dependencies
+
+---
+
+## 📖 Documentation
+
+- **[Database Support Guide](DATABASE_SUPPORT.md)** - Complete guide for all 13+ databases
+- **[Quick Reference](QUICK_DATABASE_REFERENCE.md)** - Quick setup examples
+- **[Changelog](CHANGELOG.md)** - Version history and updates
+- **[Release Notes](RELEASE_v1.0.3.md)** - Latest release information
+
+---
+
+## 🔧 Troubleshooting
+
+### Email Notifications Not Working
+
+1. Check Gmail App Password is correct (16 characters, no spaces)
+2. Verify 2-Step Verification is enabled
+3. Check environment variables are loaded
+4. Review logs in `./logs` directory
+
+### Database Connection Failures
 
-- [ ] [Set up project integrations](https://gitlab.com/manish-proses/pms_md/-/settings/integrations)
+1. Verify database driver is installed
+2. Check connection credentials
+3. Ensure database server is running
+4. Review database-specific logs
 
-## Collaborate with your team
+### High Memory Usage
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+1. Adjust `monitoring.interval` to reduce frequency
+2. Reduce `logging.maxFiles` retention period
+3. Disable unused monitoring features
 
-## Test and Deploy
+---
 
-Use the built-in continuous integration in GitLab.
+## 🤝 Contributing
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-***
+---
 
-# Editing this README
+## 📄 License
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+ISC License - see LICENSE file for details
 
-## Suggestions for a good README
+---
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+## 👤 Author
 
-## Name
-Choose a self-explaining name for your project.
+**Manish Proses**
+- Email: manish.proses@gmail.com
+- GitLab: https://gitlab.com/manish-proses/pms_md
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+---
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+## 🙏 Acknowledgments
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+Built with:
+- [Winston](https://github.com/winstonjs/winston) - Logging
+- [Nodemailer](https://nodemailer.com/) - Email notifications
+- [Express](https://expressjs.com/) - Web framework
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+---
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+## 📊 Version History
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+### v1.0.3 (Latest)
+- ✅ Added MSSQL (SQL Server) support
+- ✅ Added MariaDB support
+- ✅ Added SQLite support
+- ✅ Added CouchDB support
+- ✅ Added Cassandra support
+- ✅ Added Elasticsearch support
+- ✅ Added DynamoDB support
+- ✅ Added Neo4j support
+- ✅ Comprehensive documentation
+- ✅ 100% test coverage
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### v1.0.2
+- ✅ Enhanced MySQL2 support (v2 and v3)
+- ✅ Added Sequelize ORM support
+- ✅ Improved peer dependencies
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+### v1.0.1
+- ✅ Initial release
+- ✅ MongoDB, PostgreSQL, MySQL, Redis support
+- ✅ Email notifications
+- ✅ Health monitoring
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+---
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## 🚀 What's Next?
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+Planned features for future releases:
+- TypeScript definitions
+- Prometheus metrics export
+- Custom alerting rules
+- Performance profiling
+- Distributed tracing
 
-## License
-For open source projects, say how it is licensed.
+---
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+**Made with ❤️ for the Node.js community**