pms_md 1.0.0

package/node-monitor/README.md

@@ -0,0 +1,458 @@
+# 🚀 Node Monitor
+
+A comprehensive, production-ready monitoring solution for Node.js applications with error tracking, health checks, system resource monitoring, database connection monitoring, and multi-channel notifications.
+
+## ✨ Features
+
+- **🔍 API Error Tracking** - Automatic error logging and tracking with Express/Fastify middleware
+- **💓 Server Health Monitoring** - Heartbeat mechanism with customizable health checks
+- **📊 System Resource Monitoring** - CPU, memory, and event loop monitoring with configurable thresholds
+- **🗄️ Database Connection Monitoring** - Support for MongoDB, PostgreSQL, MySQL, and Redis
+- **📧 Multi-Channel Notifications** - Email, Slack, and SMS alerts
+- **📝 Advanced Logging** - Winston-based logging with rotation and sanitization
+- **⚙️ Highly Configurable** - Environment variables and programmatic configuration
+- **🔒 Security-First** - Sensitive data sanitization and secure credential handling
+- **📈 Metrics & Analytics** - Historical metrics tracking and dashboard endpoints
+- **🎯 Zero Dependencies Overhead** - Peer dependencies for database drivers (install only what you need)
+
+## 📦 Installation
+
+```bash
+npm install @projectmd/node-monitor
+```
+
+### Optional Peer Dependencies
+
+Install only the database drivers you need:
+
+```bash
+# For MongoDB/Mongoose
+npm install mongoose
+
+# For PostgreSQL
+npm install pg
+
+# For MySQL
+npm install mysql2
+
+# For Redis
+npm install ioredis
+
+# For Express (if not already installed)
+npm install express
+```
+
+## 🚀 Quick Start
+
+### Basic Setup
+
+```javascript
+const express = require('express');
+const NodeMonitor = require('@projectmd/node-monitor');
+
+// Initialize monitor
+const monitor = new NodeMonitor({
+  app: {
+    name: 'My App',
+    version: '1.0.0'
+  },
+  notifications: {
+    email: {
+      enabled: true,
+      host: 'smtp.gmail.com',
+      port: 587,
+      auth: {
+        user: 'your-email@gmail.com',
+        pass: 'your-app-password'
+      },
+      recipients: ['admin@example.com']
+    }
+  }
+});
+
+const app = express();
+
+// Add monitoring middleware
+app.use(monitor.requestLogger());
+
+// Add health check endpoint
+app.get('/health', monitor.healthCheckEndpoint());
+
+// Your routes here
+app.get('/', (req, res) => {
+  res.json({ message: 'Hello World' });
+});
+
+// Error handling (must be last)
+app.use(monitor.notFoundHandler());
+app.use(monitor.errorMiddleware());
+
+// Start server
+const server = app.listen(3000, () => {
+  console.log('Server running on port 3000');
+  
+  // Start monitoring
+  monitor.start();
+  
+  // Setup graceful shutdown
+  monitor.setupGracefulShutdown(server);
+});
+```
+
+## 📖 Configuration
+
+### Environment Variables
+
+Create a `.env` file (see `.env.example` for all options):
+
+```env
+# Application
+MONITOR_APP_NAME=my-app
+NODE_ENV=production
+
+# Thresholds
+MONITOR_CPU_THRESHOLD=80
+MONITOR_MEMORY_THRESHOLD=90
+MONITOR_ERROR_RATE_THRESHOLD=50
+
+# Email Notifications
+MONITOR_EMAIL_ENABLED=true
+MONITOR_EMAIL_HOST=smtp.gmail.com
+MONITOR_EMAIL_USER=your-email@gmail.com
+MONITOR_EMAIL_PASS=your-password
+MONITOR_EMAIL_RECIPIENTS=admin@example.com
+
+# Slack Notifications
+MONITOR_SLACK_ENABLED=true
+MONITOR_SLACK_WEBHOOK=https://hooks.slack.com/services/YOUR/WEBHOOK
+```
+
+### Programmatic Configuration
+
+```javascript
+const monitor = new NodeMonitor({
+  intervals: {
+    health: 60000,      // 1 minute
+    system: 300000,     // 5 minutes
+    database: 120000    // 2 minutes
+  },
+  
+  thresholds: {
+    cpu: 80,
+    memory: 90,
+    errorRate: 50,
+    responseTime: 5000,
+    consecutiveFailures: 3
+  },
+  
+  notifications: {
+    enabled: true,
+    cooldown: 300000,   // 5 minutes
+    
+    email: { /* ... */ },
+    slack: { /* ... */ }
+  },
+  
+  logging: {
+    enabled: true,
+    level: 'info',
+    directory: './logs'
+  }
+});
+```
+
+## 🎯 Usage Examples
+
+### API Error Tracking
+
+```javascript
+// Automatic error tracking with middleware
+app.use(monitor.errorMiddleware());
+
+// Manual error logging
+app.get('/api/data', async (req, res, next) => {
+  try {
+    const data = await fetchData();
+    res.json(data);
+  } catch (error) {
+    monitor.logError('data_fetch_failed', error.message, {
+      userId: req.user?.id
+    });
+    next(error);
+  }
+});
+
+// Async handler wrapper
+app.get('/api/users', monitor.asyncHandler(async (req, res) => {
+  const users = await User.find();
+  res.json(users);
+}));
+
+// Create custom errors
+const error = NodeMonitor.createError('Not found', 404);
+```
+
+### Health Checks
+
+```javascript
+// Register custom health checks
+monitor.registerHealthCheck('database', async () => {
+  try {
+    await db.ping();
+    return true;
+  } catch {
+    return false;
+  }
+});
+
+monitor.registerHealthCheck('external-api', async () => {
+  const response = await fetch('https://api.example.com/health');
+  return response.ok;
+});
+
+// Health check endpoint
+app.get('/health', monitor.healthCheckEndpoint());
+
+// Basic health info
+app.get('/health/info', monitor.healthInfoEndpoint());
+```
+
+### Database Monitoring
+
+```javascript
+// MongoDB/Mongoose
+const mongoose = require('mongoose');
+await mongoose.connect('mongodb://localhost:27017/myapp');
+monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
+
+// PostgreSQL
+const { Pool } = require('pg');
+const pgPool = new Pool({ connectionString: 'postgresql://...' });
+monitor.registerDatabase('postgres', 'postgresql', pgPool);
+
+// MySQL
+const mysql = require('mysql2/promise');
+const mysqlPool = mysql.createPool({ /* config */ });
+monitor.registerDatabase('mysql', 'mysql', mysqlPool);
+
+// Redis
+const Redis = require('ioredis');
+const redis = new Redis();
+monitor.registerDatabase('redis', 'redis', redis);
+
+// Get database stats
+const stats = await monitor.getDatabaseStats('mongodb');
+```
+
+### System Monitoring
+
+```javascript
+// Get current metrics
+const metrics = monitor.getStatus();
+console.log(metrics.system); // { cpu: {...}, memory: {...} }
+
+// Get system information
+const sysInfo = monitor.getSystemInfo();
+
+// Get metrics history
+const history = monitor.getMetricsHistory();
+```
+
+### Custom Notifications
+
+```javascript
+// Send custom notifications
+await monitor.notify('critical', 'Payment Failed', 
+  'Payment processing system is down', 
+  { transactionId: '12345' }
+);
+
+await monitor.notify('warning', 'High Traffic', 
+  'Traffic spike detected',
+  { requestsPerMinute: 10000 }
+);
+
+await monitor.notify('info', 'Deployment Complete',
+  'Version 2.0.0 deployed successfully'
+);
+```
+
+### Monitoring Dashboard
+
+```javascript
+// JSON dashboard endpoint
+app.get('/monitor/dashboard', monitor.dashboardEndpoint());
+
+// Custom dashboard
+app.get('/admin/monitor', (req, res) => {
+  const status = monitor.getStatus();
+  const systemInfo = monitor.getSystemInfo();
+  
+  res.render('dashboard', { status, systemInfo });
+});
+```
+
+## 📊 API Reference
+
+### Main Methods
+
+#### `monitor.start()`
+Start all monitoring services (health checks, system monitoring, database monitoring).
+
+#### `monitor.stop()`
+Stop all monitoring services.
+
+#### `monitor.getStatus()`
+Get current monitoring status including health, system metrics, database status, and error stats.
+
+#### `monitor.notify(level, subject, message, details)`
+Send notification through all enabled channels.
+- `level`: 'critical', 'warning', 'info', or 'recovery'
+
+### Middleware
+
+#### `monitor.errorMiddleware()`
+Express error handling middleware. Must be added last.
+
+#### `monitor.requestLogger()`
+Logs all requests and tracks slow responses.
+
+#### `monitor.notFoundHandler()`
+404 handler middleware.
+
+#### `monitor.asyncHandler(fn)`
+Wraps async route handlers to catch errors.
+
+### Health Monitoring
+
+#### `monitor.registerHealthCheck(name, checkFunction)`
+Register a custom health check.
+
+#### `monitor.healthCheckEndpoint()`
+Returns Express middleware for `/health` endpoint.
+
+#### `monitor.setupGracefulShutdown(server)`
+Setup graceful shutdown handlers for SIGTERM/SIGINT.
+
+### Database Monitoring
+
+#### `monitor.registerDatabase(name, type, connection, testQuery)`
+Register a database connection for monitoring.
+- `type`: 'mongoose', 'postgresql', 'mysql', or 'redis'
+
+#### `monitor.getDatabaseStats(name)`
+Get statistics for a specific database connection.
+
+### Logging
+
+#### `monitor.logError(type, message, details)`
+Log a custom error.
+
+#### `monitor.logWarning(type, message, details)`
+Log a warning.
+
+#### `monitor.logInfo(message, details)`
+Log informational message.
+
+#### `monitor.getLogger()`
+Get Winston logger instance for advanced usage.
+
+## 🔔 Notification Channels
+
+### Email (Nodemailer)
+
+```javascript
+notifications: {
+  email: {
+    enabled: true,
+    host: 'smtp.gmail.com',
+    port: 587,
+    secure: false,
+    auth: {
+      user: 'your-email@gmail.com',
+      pass: 'your-app-password'
+    },
+    from: 'alerts@myapp.com',
+    recipients: ['admin@example.com', 'ops@example.com']
+  }
+}
+```
+
+### Slack
+
+```javascript
+notifications: {
+  slack: {
+    enabled: true,
+    webhook: 'https://hooks.slack.com/services/YOUR/WEBHOOK/URL',
+    channel: '#monitoring',
+    username: 'Node Monitor'
+  }
+}
+```
+
+## 🔒 Security Features
+
+- **Sensitive Data Sanitization** - Automatically redacts passwords, tokens, API keys from logs
+- **Environment Variable Support** - Keep credentials out of code
+- **Configurable Fields** - Customize which fields to sanitize
+- **Secure Communication** - HTTPS for webhooks, TLS for email
+
+## 📈 Monitoring Endpoints
+
+| Endpoint | Description |
+|----------|-------------|
+| `/health` | Full health check with all registered checks |
+| `/health/info` | Basic health information |
+| `/monitor/dashboard` | Complete monitoring dashboard (JSON) |
+| `/monitor/status` | Current monitoring status |
+| `/monitor/system` | System information |
+| `/monitor/metrics` | Historical metrics |
+
+## 🎨 Example Output
+
+### Health Check Response
+```json
+{
+  "status": "healthy",
+  "timestamp": "2024-01-15T10:30:00.000Z",
+  "uptime": "2d 5h 30m 15s",
+  "checks": {
+    "database": { "status": "pass" },
+    "external-api": { "status": "pass" }
+  }
+}
+```
+
+### Dashboard Response
+```json
+{
+  "status": "ok",
+  "application": {
+    "name": "My App",
+    "version": "1.0.0",
+    "environment": "production"
+  },
+  "monitoring": {
+    "isRunning": true,
+    "health": { "isHealthy": true, "uptime": "2d 5h" },
+    "system": {
+      "cpu": { "process": 15.5, "system": 45.2 },
+      "memory": { "system": { "usagePercent": 65.3 } }
+    }
+  }
+}
+```
+
+## 📝 License
+
+MIT
+
+## 🤝 Contributing
+
+Contributions welcome! Please read our contributing guidelines first.
+
+## 📞 Support
+
+For issues and questions, please open an issue on GitHub.
+

package/node-monitor/READY_TO_PUBLISH.md

@@ -0,0 +1,272 @@
+# 🎉 Your Package is Ready to Publish!
+
+## ✅ What We've Done
+
+### 1. Created `.npmignore` File ✅
+- Excludes development files, logs, and sensitive data
+- Keeps package size small (81.7 kB)
+- Located at: `node-monitor/.npmignore`
+
+### 2. Updated `package.json` ✅
+Added the following fields:
+- **Repository:** `git+https://github.com/projectmd/node-monitor.git`
+- **Bugs URL:** `https://github.com/projectmd/node-monitor/issues`
+- **Homepage:** `https://github.com/projectmd/node-monitor#readme`
+- **Additional Keywords:** Added more keywords for better discoverability
+- **Scripts:** Added `prepublishOnly` and `version` scripts
+
+### 3. Created Publishing Tools ✅
+- **PUBLISHING_GUIDE.md** - Complete step-by-step publishing guide
+- **pre-publish-check.js** - Validation script to check package readiness
+- **READY_TO_PUBLISH.md** - This file!
+
+### 4. Ran Pre-Publish Checks ✅
+All checks passed:
+- ✅ Package name: `@projectmd/node-monitor`
+- ✅ Version: `1.0.0`
+- ✅ Main entry point exists
+- ✅ README.md exists (10,526 characters)
+- ✅ LICENSE file exists (MIT)
+- ✅ .npmignore configured
+- ✅ No sensitive files
+- ✅ 10 source files ready
+- ✅ Dependencies installed
+
+### 5. Ran Dry Run ✅
+Package details:
+- **Package size:** 81.7 kB (compressed)
+- **Unpacked size:** 346.1 kB
+- **Total files:** 47 files
+- **Includes:** Source code, documentation, examples, views
+
+---
+
+## 📦 What Will Be Published
+
+### Included Files (47 total):
+
+**Documentation:**
+- ARCHITECTURE.md
+- CHANGELOG.md
+- CONTRIBUTING.md
+- GETTING_STARTED.md
+- INSTALLATION.md
+- LICENSE
+- PUBLISHING_GUIDE.md
+- QUICK_REFERENCE.md
+- README.md
+- SETUP_GUIDE.md
+
+**Source Code:**
+- src/index.js (main entry point)
+- src/config/monitoringConfig.js
+- src/logger/errorLogger.js
+- src/monitors/ (4 monitor files)
+- src/notifiers/ (3 notifier files)
+- src/views/ (3 HTML templates)
+
+**Examples:**
+- examples/express-app.js
+- examples/package.json
+- examples/views/ (EJS templates)
+- examples/public/ (CSS and JS files)
+- examples/EMAIL_SETUP_GUIDE.md
+- examples/ERROR_LOGGING_GUIDE.md
+- examples/GET_APP_PASSWORD.md
+- examples/LOG_FILES_REFERENCE.md
+- examples/QUICK_START_EMAIL.md
+
+**Package Files:**
+- package.json
+- pre-publish-check.js
+
+### Excluded Files (via .npmignore):
+- ❌ node_modules/
+- ❌ examples/node_modules/
+- ❌ examples/logs/
+- ❌ .env files
+- ❌ logs/
+- ❌ Test files
+- ❌ IDE configuration
+- ❌ BUILD_COMPLETE.md
+- ❌ PROJECT_SUMMARY.md
+- ❌ RUNNING_GUIDE.md
+- ❌ EJS_UI_GUIDE.md
+- ❌ UI_GUIDE.md
+- ❌ test-ui.ps1
+
+---
+
+## 🚀 Ready to Publish!
+
+### Quick Publish Steps:
+
+```bash
+# 1. Login to npm (if not already logged in)
+npm login
+
+# 2. Verify you're logged in
+npm whoami
+
+# 3. Publish the package
+npm publish --access public
+```
+
+### Detailed Steps:
+
+See **PUBLISHING_GUIDE.md** for complete instructions.
+
+---
+
+## 📊 Package Information
+
+```json
+{
+  "name": "@projectmd/node-monitor",
+  "version": "1.0.0",
+  "description": "Comprehensive monitoring solution for Node.js applications",
+  "main": "src/index.js",
+  "license": "MIT",
+  "repository": "git+https://github.com/projectmd/node-monitor.git"
+}
+```
+
+**Package Size:** 81.7 kB  
+**Unpacked Size:** 346.1 kB  
+**Total Files:** 47  
+**Node Version:** >=14.0.0
+
+---
+
+## 🔗 After Publishing
+
+Once published, your package will be available at:
+
+**npm Package Page:**
+```
+https://www.npmjs.com/package/@projectmd/node-monitor
+```
+
+**Installation Command:**
+```bash
+npm install @projectmd/node-monitor
+```
+
+**Usage:**
+```javascript
+const NodeMonitor = require('@projectmd/node-monitor');
+const monitor = new NodeMonitor();
+```
+
+---
+
+## 📝 Important Notes
+
+### Before Publishing:
+
+1. **Update GitHub Repository URL** (if different):
+   - Edit `package.json` lines 30-37
+   - Replace `projectmd/node-monitor` with your actual GitHub username/repo
+
+2. **Create GitHub Repository** (if not exists):
+   ```bash
+   # Create repo on GitHub first, then:
+   git init
+   git add .
+   git commit -m "Initial commit"
+   git remote add origin https://github.com/projectmd/node-monitor.git
+   git push -u origin main
+   ```
+
+3. **Verify npm Login:**
+   ```bash
+   npm whoami
+   # Should show your npm username
+   ```
+
+### After Publishing:
+
+1. **Verify Publication:**
+   ```bash
+   npm view @projectmd/node-monitor
+   ```
+
+2. **Test Installation:**
+   ```bash
+   # In a test project
+   npm install @projectmd/node-monitor
+   ```
+
+3. **Update GitHub:**
+   ```bash
+   git push
+   git tag v1.0.0
+   git push --tags
+   ```
+
+---
+
+## 🎯 Next Steps
+
+### Immediate:
+- [ ] Create GitHub repository (if not exists)
+- [ ] Update repository URL in package.json (if needed)
+- [ ] Login to npm: `npm login`
+- [ ] Publish: `npm publish --access public`
+
+### After Publishing:
+- [ ] Verify package on npmjs.com
+- [ ] Test installation in a new project
+- [ ] Add npm badge to README.md
+- [ ] Share with the community!
+
+### Future Updates:
+- [ ] Add tests (Jest is already configured)
+- [ ] Set up CI/CD (GitHub Actions)
+- [ ] Monitor package downloads
+- [ ] Respond to issues and PRs
+- [ ] Release updates with `npm version` and `npm publish`
+
+---
+
+## 🆘 Need Help?
+
+**Documentation:**
+- See `PUBLISHING_GUIDE.md` for detailed publishing instructions
+- See `GETTING_STARTED.md` for usage examples
+- See `INSTALLATION.md` for installation options
+
+**Validation:**
+```bash
+# Run pre-publish checks
+node pre-publish-check.js
+
+# Test package locally
+npm pack
+```
+
+**Troubleshooting:**
+- Not logged in? Run `npm login`
+- Package name taken? Change name in package.json
+- Version exists? Run `npm version patch`
+
+---
+
+## 🎉 Congratulations!
+
+Your Node Monitor package is **production-ready** and **ready to publish**!
+
+This is a comprehensive monitoring solution that will help Node.js developers monitor their applications with:
+- ✅ Error tracking
+- ✅ Health checks
+- ✅ System monitoring
+- ✅ Database monitoring
+- ✅ Email & Slack notifications
+- ✅ Beautiful web dashboard
+
+**You've built something amazing! Now share it with the world! 🚀**
+
+---
+
+**Good luck with your npm package!** 🎊
+