pms_md 1.0.0

package/node-monitor/examples/EMAIL_SETUP_GUIDE.md

@@ -0,0 +1,282 @@
+# 📧 Email Notification Setup Guide
+
+## 🎯 Overview
+
+Your Node Monitor is now configured to send email notifications to **manish.proses@gmail.com** for:
+- ✅ Server errors and crashes
+- ✅ API errors
+- ✅ High CPU usage (>75%)
+- ✅ High memory usage (>85%)
+- ✅ High error rates (>10 errors/minute)
+- ✅ Slow response times (>3 seconds)
+- ✅ Database connection failures
+
+---
+
+## 🔐 Step 1: Get Gmail App Password
+
+Since you're using Gmail, you need to create an **App Password** (not your regular Gmail password).
+
+### Instructions:
+
+1. **Enable 2-Step Verification** (if not already enabled):
+   - Go to: https://myaccount.google.com/security
+   - Click on "2-Step Verification"
+   - Follow the setup process
+
+2. **Create App Password**:
+   - Go to: https://myaccount.google.com/apppasswords
+   - Select app: **Mail**
+   - Select device: **Other (Custom name)**
+   - Enter name: **Node Monitor**
+   - Click **Generate**
+
+3. **Copy the 16-character password**:
+   - It will look like: `abcd efgh ijkl mnop`
+   - Remove spaces: `abcdefghijklmnop`
+
+---
+
+## 📝 Step 2: Update .env File
+
+Open the file: `node-monitor/examples/.env`
+
+Replace this line:
+```env
+EMAIL_APP_PASSWORD=your-gmail-app-password-here
+```
+
+With your actual App Password:
+```env
+EMAIL_APP_PASSWORD=abcdefghijklmnop
+```
+
+**IMPORTANT:** 
+- ✅ Remove all spaces from the password
+- ✅ Keep the .env file secure (it's already in .gitignore)
+- ❌ Never commit this file to Git
+- ❌ Never share this password
+
+---
+
+## 🚀 Step 3: Restart the Server
+
+After updating the .env file, restart your server:
+
+```bash
+cd node-monitor/examples
+node express-app.js
+```
+
+---
+
+## 🧪 Step 4: Test Email Notifications
+
+### Test 1: Manual Test Notification
+
+Open your browser and visit:
+```
+http://localhost:3001/api/notify-test
+```
+
+Or use curl:
+```bash
+curl http://localhost:3001/api/notify-test
+```
+
+You should receive an email with subject: **[Example Express App] Test Notification**
+
+### Test 2: Trigger an Error
+
+Click the "✗ Error" button on the home page, or visit:
+```
+http://localhost:3001/api/error
+```
+
+After 2 consecutive errors, you'll receive an email alert.
+
+### Test 3: Trigger High Error Rate
+
+Visit the error endpoint multiple times quickly:
+```bash
+# Run this 15 times to trigger high error rate alert
+for i in {1..15}; do curl http://localhost:3001/api/error; done
+```
+
+You should receive an email about high error rate.
+
+---
+
+## 📧 What Emails Will You Receive?
+
+### 1. **Critical Alerts** (Red)
+- Server crashes
+- Database connection failures
+- High error rates (>10 errors/minute)
+- Consecutive health check failures
+
+**Example Subject:** `[Example Express App] 🚨 Critical: High Error Rate Detected`
+
+### 2. **Warning Alerts** (Yellow)
+- High CPU usage (>75%)
+- High memory usage (>85%)
+- Slow response times (>3 seconds)
+- Individual API errors
+
+**Example Subject:** `[Example Express App] ⚠️ Warning: High CPU Usage`
+
+### 3. **Info Notifications** (Blue)
+- Server startup
+- Test notifications
+- Manual notifications
+
+**Example Subject:** `[Example Express App] ℹ️ Info: Server Started`
+
+### 4. **Recovery Notifications** (Green)
+- System recovered from high CPU
+- Error rate back to normal
+- Database connection restored
+
+**Example Subject:** `[Example Express App] ✅ Recovery: System Healthy`
+
+---
+
+## ⚙️ Customization
+
+### Change Alert Thresholds
+
+Edit `node-monitor/examples/express-app.js`:
+
+```javascript
+thresholds: {
+  cpu: 75,            // Alert if CPU > 75% (change this)
+  memory: 85,         // Alert if memory > 85% (change this)
+  errorRate: 10,      // Alert if > 10 errors per minute (change this)
+  responseTime: 3000, // Alert if response time > 3 seconds (change this)
+  consecutiveFailures: 2  // Alert after 2 consecutive failures (change this)
+}
+```
+
+### Change Cooldown Period
+
+To prevent spam, there's a cooldown between alerts:
+
+```javascript
+notifications: {
+  enabled: true,
+  cooldown: 180000,   // 3 minutes (change this)
+  // ...
+}
+```
+
+### Add More Recipients
+
+Edit `node-monitor/examples/express-app.js`:
+
+```javascript
+email: {
+  enabled: true,
+  // ...
+  recipients: [
+    'manish.proses@gmail.com',
+    'another-email@example.com',  // Add more emails here
+    'ops-team@example.com'
+  ]
+}
+```
+
+---
+
+## 🔍 Troubleshooting
+
+### Problem: Not Receiving Emails
+
+**Check 1: Verify App Password**
+- Make sure you copied the entire 16-character password
+- Remove all spaces
+- It should be in the .env file
+
+**Check 2: Check Server Logs**
+Look for email-related messages:
+```bash
+# Check if email notifier initialized
+# You should see: "Email notifier initialized successfully"
+```
+
+**Check 3: Test Email Configuration**
+Visit: http://localhost:3001/api/notify-test
+
+Check the response - it should show:
+```json
+{
+  "message": "Test notification sent!",
+  "result": {
+    "total": 1,
+    "successful": 1,
+    "failed": 0
+  }
+}
+```
+
+**Check 4: Gmail Security**
+- Make sure 2-Step Verification is enabled
+- Make sure you're using an App Password (not your regular password)
+- Check Gmail's "Less secure app access" is NOT blocking it
+
+### Problem: Emails Going to Spam
+
+1. Check your Gmail spam folder
+2. Mark the email as "Not Spam"
+3. Add the sender to your contacts
+
+### Problem: Too Many Emails
+
+Increase the cooldown period:
+```javascript
+cooldown: 300000,   // 5 minutes instead of 3
+```
+
+Or increase the thresholds:
+```javascript
+thresholds: {
+  cpu: 90,           // Only alert if CPU > 90%
+  memory: 95,        // Only alert if memory > 95%
+  errorRate: 20,     // Only alert if > 20 errors per minute
+}
+```
+
+---
+
+## 📊 Email Content
+
+Each email includes:
+- **Subject:** Alert type and description
+- **Message:** Detailed explanation
+- **Application:** Name and version
+- **Environment:** development/production
+- **Hostname:** Server hostname
+- **Timestamp:** When the alert occurred
+- **Details:** Specific metrics (CPU %, memory %, error count, etc.)
+
+---
+
+## 🔒 Security Best Practices
+
+1. ✅ **Never commit .env file** - It's already in .gitignore
+2. ✅ **Use App Passwords** - Never use your main Gmail password
+3. ✅ **Rotate passwords** - Change App Password periodically
+4. ✅ **Limit recipients** - Only send to authorized personnel
+5. ✅ **Use environment variables** - Keep secrets out of code
+
+---
+
+## 🎉 You're All Set!
+
+Once you complete the setup:
+1. ✅ Update .env with your Gmail App Password
+2. ✅ Restart the server
+3. ✅ Test with http://localhost:3001/api/notify-test
+4. ✅ Check your email inbox
+
+**You'll now receive email alerts for all critical issues!** 📧🚀
+

package/node-monitor/examples/ERROR_LOGGING_GUIDE.md

@@ -0,0 +1,405 @@
+# 📋 API Error Logging Guide
+
+## 🎯 Overview
+
+Your Node Monitor now includes a comprehensive error logging system that automatically tracks, stores, and displays all API errors in a beautiful web interface.
+
+---
+
+## ✅ What's Included
+
+### 1. **Automatic Error Logging**
+- ✅ All API errors are automatically logged
+- ✅ Errors saved to JSON files (one per day)
+- ✅ Includes full error details, stack traces, request info
+- ✅ Sensitive data automatically sanitized (passwords, tokens, etc.)
+
+### 2. **Web-Based Error Viewer**
+- ✅ Beautiful, interactive error log viewer
+- ✅ View errors by date
+- ✅ Search and filter capabilities
+- ✅ Expandable stack traces
+- ✅ Download logs as JSON
+- ✅ Auto-refresh every 30 seconds
+
+### 3. **Error Statistics**
+- ✅ Total error count
+- ✅ Latest error timestamp
+- ✅ Most common error messages
+- ✅ Error rate tracking
+
+### 4. **Email Notifications**
+- ✅ Instant alerts for critical errors
+- ✅ High error rate warnings
+- ✅ Sent to: manish.proses@gmail.com
+
+---
+
+## 🌐 Access Error Logs
+
+### **Web Interface:**
+```
+http://localhost:3001/monitor/error-logs
+```
+
+Or click **"🔴 Error Logs"** in the navigation menu.
+
+### **API Endpoints:**
+
+**Get list of log files:**
+```
+GET /monitor/error-logs?format=json
+```
+
+**Get specific log file:**
+```
+GET /monitor/error-logs/error-2025-11-12.log?format=json&limit=100
+```
+
+**Download log file:**
+```
+GET /monitor/error-logs/error-2025-11-12.log
+```
+
+---
+
+## 📁 Log File Structure
+
+### **Location:**
+```
+node-monitor/examples/logs/
+```
+
+### **Files:**
+- `error-YYYY-MM-DD.log` - Error logs only
+- `application-YYYY-MM-DD.log` - All logs (info, warnings, errors)
+
+### **Format:**
+Each line is a JSON object:
+
+```json
+{
+  "level": "error",
+  "message": "API Error This is a test error",
+  "type": "API_ERROR",
+  "method": "GET",
+  "url": "/api/error",
+  "statusCode": 500,
+  "timestamp": "2025-11-12T06:00:03.618Z",
+  "ip": "::1",
+  "userAgent": "Mozilla/5.0...",
+  "headers": { ... },
+  "query": { ... },
+  "body": { ... },
+  "stack": "Error: This is a test error\n    at ...",
+  "app": {
+    "name": "Example Express App",
+    "version": "1.0.0",
+    "environment": "production",
+    "hostname": "MD"
+  }
+}
+```
+
+---
+
+## 🔍 Error Log Details
+
+Each error log includes:
+
+| Field | Description |
+|-------|-------------|
+| **level** | Log level (error, warn, info) |
+| **message** | Error message |
+| **type** | Error type (API_ERROR, SYSTEM_ERROR, etc.) |
+| **method** | HTTP method (GET, POST, etc.) |
+| **url** | Request URL |
+| **statusCode** | HTTP status code (500, 404, etc.) |
+| **timestamp** | When the error occurred (ISO 8601) |
+| **ip** | Client IP address |
+| **userAgent** | Client browser/app |
+| **headers** | Request headers (sanitized) |
+| **query** | Query parameters (sanitized) |
+| **body** | Request body (sanitized) |
+| **stack** | Full stack trace |
+| **app** | Application metadata |
+
+---
+
+## 🛡️ Security Features
+
+### **Automatic Data Sanitization:**
+
+Sensitive fields are automatically redacted:
+- `password` → `***REDACTED***`
+- `token` → `***REDACTED***`
+- `apiKey` → `***REDACTED***`
+- `secret` → `***REDACTED***`
+- `authorization` → `***REDACTED***`
+
+**Example:**
+```json
+{
+  "body": {
+    "username": "john@example.com",
+    "password": "***REDACTED***"
+  }
+}
+```
+
+---
+
+## 📊 Using the Web Interface
+
+### **Features:**
+
+1. **Date Selector**
+   - Select which day's logs to view
+   - Dropdown shows all available log files
+   - Most recent logs shown first
+
+2. **Statistics Dashboard**
+   - Total error count
+   - Latest error timestamp
+   - Most common error message
+
+3. **Error List**
+   - Each error shown as a card
+   - Click to expand stack trace
+   - Color-coded by severity
+
+4. **Actions**
+   - **🔄 Refresh** - Reload current log file
+   - **📥 Download** - Download log as JSON file
+
+5. **Auto-Refresh**
+   - Automatically refreshes every 30 seconds
+   - Always shows latest errors
+
+---
+
+## 🔧 Configuration
+
+### **Enable/Disable Logging:**
+
+Edit `node-monitor/examples/express-app.js`:
+
+```javascript
+logging: {
+  enabled: true,           // Set to false to disable
+  level: 'info',          // 'error', 'warn', 'info', 'debug'
+  directory: './logs',    // Where to store logs
+  console: true           // Also log to console
+}
+```
+
+### **Log Rotation:**
+
+Logs are automatically rotated daily:
+- New file created each day
+- Old files kept for 14 days (configurable)
+- Maximum file size: 20MB (configurable)
+
+### **Change Retention:**
+
+Edit `node-monitor/src/config/monitoringConfig.js`:
+
+```javascript
+logging: {
+  maxFiles: '14d',    // Keep logs for 14 days
+  maxSize: '20m'      // Max 20MB per file
+}
+```
+
+---
+
+## 📧 Email Notifications
+
+Errors trigger email notifications when:
+
+| Condition | Threshold | Email Type |
+|-----------|-----------|------------|
+| Single API Error | Any error | Warning ⚠️ |
+| High Error Rate | >10 errors/min | Critical 🚨 |
+| Consecutive Failures | 2+ failures | Critical 🚨 |
+
+**Cooldown:** 3 minutes between alerts (prevents spam)
+
+**Recipient:** manish.proses@gmail.com
+
+---
+
+## 🧪 Testing Error Logging
+
+### **Test 1: Trigger a Single Error**
+
+Visit: http://localhost:3001/api/error
+
+**Expected:**
+- Error logged to `logs/error-YYYY-MM-DD.log`
+- Visible in Error Logs viewer
+- Email sent (if configured)
+
+### **Test 2: Trigger High Error Rate**
+
+Run this command:
+```bash
+for ($i=1; $i -le 15; $i++) { curl http://localhost:3001/api/error }
+```
+
+**Expected:**
+- 15 errors logged
+- High error rate email alert
+- All errors visible in viewer
+
+### **Test 3: View Logs**
+
+1. Go to: http://localhost:3001/monitor/error-logs
+2. Select today's date
+3. See all errors listed
+4. Click "Show Stack Trace" to expand details
+
+---
+
+## 📥 Exporting Logs
+
+### **Method 1: Download from Web Interface**
+
+1. Go to Error Logs page
+2. Select the date
+3. Click **"📥 Download"** button
+4. JSON file downloads automatically
+
+### **Method 2: API Endpoint**
+
+```bash
+curl http://localhost:3001/monitor/error-logs/error-2025-11-12.log -o error-log.json
+```
+
+### **Method 3: Direct File Access**
+
+```bash
+# Copy log file
+cp node-monitor/examples/logs/error-2025-11-12.log ./my-error-log.json
+```
+
+---
+
+## 🔍 Analyzing Logs
+
+### **Using Command Line:**
+
+**Count total errors:**
+```bash
+wc -l logs/error-2025-11-12.log
+```
+
+**Find specific error:**
+```bash
+grep "This is a test error" logs/error-2025-11-12.log
+```
+
+**Extract error messages:**
+```bash
+cat logs/error-2025-11-12.log | jq '.message'
+```
+
+### **Using JavaScript:**
+
+```javascript
+const fs = require('fs');
+
+// Read log file
+const content = fs.readFileSync('logs/error-2025-11-12.log', 'utf8');
+const errors = content.split('\n')
+  .filter(line => line.trim())
+  .map(line => JSON.parse(line));
+
+// Analyze errors
+console.log('Total errors:', errors.length);
+console.log('Error types:', [...new Set(errors.map(e => e.type))]);
+console.log('Status codes:', [...new Set(errors.map(e => e.statusCode))]);
+```
+
+---
+
+## 🚀 Integration with Your Projects
+
+### **Step 1: Copy the Monitoring System**
+
+```bash
+# Copy the entire node-monitor folder to your project
+cp -r node-monitor /path/to/your/project/
+```
+
+### **Step 2: Install Dependencies**
+
+```bash
+cd /path/to/your/project
+npm install winston winston-daily-rotate-file nodemailer
+```
+
+### **Step 3: Initialize in Your App**
+
+```javascript
+const NodeMonitor = require('./node-monitor/src/index');
+
+const monitor = new NodeMonitor({
+  app: {
+    name: 'Your App Name',
+    version: '1.0.0',
+    environment: process.env.NODE_ENV || 'development'
+  },
+  logging: {
+    enabled: true,
+    directory: './logs'
+  },
+  notifications: {
+    enabled: true,
+    email: {
+      enabled: true,
+      host: 'smtp.gmail.com',
+      port: 587,
+      auth: {
+        user: 'your-email@gmail.com',
+        pass: process.env.EMAIL_APP_PASSWORD
+      },
+      from: 'your-email@gmail.com',
+      recipients: ['admin@example.com']
+    }
+  }
+});
+
+// Add middleware
+app.use(monitor.requestLogger());
+app.use(monitor.errorMiddleware());
+```
+
+### **Step 4: Access Error Logs**
+
+Add the error logs routes to your Express app (copy from `express-app.js`).
+
+---
+
+## 📚 Additional Resources
+
+- **Quick Start:** `QUICK_START_EMAIL.md`
+- **Email Setup:** `EMAIL_SETUP_GUIDE.md`
+- **App Password:** `GET_APP_PASSWORD.md`
+
+---
+
+## 🎉 Summary
+
+You now have:
+- ✅ Automatic error logging to JSON files
+- ✅ Beautiful web interface to view errors
+- ✅ Email notifications for critical errors
+- ✅ Downloadable error logs
+- ✅ Automatic data sanitization
+- ✅ Daily log rotation
+- ✅ Full stack traces
+- ✅ Error statistics and analytics
+
+**All errors are automatically tracked and logged!** 📋🚀
+