pms_md 1.0.0 → 1.0.2

package/MYSQL2_SEQUELIZE_SUPPORT.md

@@ -0,0 +1,334 @@
+# ✅ MySQL2 & Sequelize Support Added
+
+## 🎉 What's New in v1.0.2
+
+Your `pms_md` monitoring package now has **full support** for:
+
+- ✅ **MySQL2** (both promise and callback-based)
+- ✅ **Sequelize ORM** (supports MySQL, PostgreSQL, SQLite, MSSQL)
+- ✅ Enhanced database connection monitoring
+- ✅ Automatic health checks for Sequelize instances
+- ✅ Database statistics and pool information
+
+---
+
+## 📦 Installation
+
+The package is already installed in your RFID project with version **1.0.2**.
+
+```bash
+# Already installed
+pms_md@1.0.2
+```
+
+---
+
+## 🚀 How to Use with Your RFID Project
+
+### Option 1: Monitor Sequelize Instance (Recommended)
+
+```javascript
+const { Sequelize } = require('sequelize');
+const NodeMonitor = require('pms_md');
+
+// Your existing Sequelize instance
+const sequelize = new Sequelize('asset_tracking', 'root', 'password', {
+  host: 'localhost',
+  dialect: 'mysql',
+  logging: false
+});
+
+// Initialize monitor
+const monitor = new NodeMonitor({
+  app: {
+    name: 'RFID Asset Tracking',
+    version: '1.0.0',
+    environment: process.env.NODE_ENV || 'development'
+  },
+  notifications: {
+    email: {
+      enabled: true,
+      host: 'smtp.gmail.com',
+      port: 587,
+      auth: {
+        user: 'manish.proses@gmail.com',
+        pass: process.env.EMAIL_APP_PASSWORD
+      },
+      recipients: ['manish.proses@gmail.com']
+    }
+  }
+});
+
+// Register Sequelize for monitoring
+monitor.registerDatabase('mysql', 'sequelize', sequelize);
+
+// Start monitoring
+monitor.start();
+```
+
+### Option 2: Monitor MySQL2 Pool Directly
+
+```javascript
+const mysql = require('mysql2/promise');
+const NodeMonitor = require('pms_md');
+
+// Create MySQL2 pool
+const pool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: 'password',
+  database: 'asset_tracking',
+  waitForConnections: true,
+  connectionLimit: 10
+});
+
+const monitor = new NodeMonitor({ /* config */ });
+
+// Register MySQL2 pool for monitoring
+monitor.registerDatabase('mysql', 'mysql2', pool);
+monitor.start();
+```
+
+---
+
+## 🔍 Features
+
+### 1. Automatic Connection Monitoring
+
+The monitor will automatically:
+- ✅ Check database connection every minute (configurable)
+- ✅ Send email alerts if connection is lost
+- ✅ Send recovery notifications when connection is restored
+- ✅ Track consecutive connection failures
+
+### 2. Database Statistics
+
+```javascript
+// Get database stats
+const stats = await monitor.getDatabaseStats('mysql');
+
+// For Sequelize, returns:
+{
+  type: 'sequelize',
+  dialect: 'mysql',
+  database: 'asset_tracking',
+  host: 'localhost',
+  pool: {
+    size: 5,
+    available: 3,
+    using: 2,
+    waiting: 0
+  }
+}
+
+// For MySQL2, returns:
+{
+  type: 'mysql',
+  threadsConnected: 5
+}
+```
+
+### 3. Health Checks
+
+```javascript
+// Add custom database health check
+monitor.registerHealthCheck('database', async () => {
+  try {
+    await sequelize.authenticate();
+    return true;
+  } catch {
+    return false;
+  }
+});
+
+// Access via endpoint
+app.get('/health', monitor.healthCheckEndpoint());
+```
+
+### 4. Connection Status
+
+```javascript
+const status = monitor.getStatus();
+console.log(status.databases);
+
+// Output:
+{
+  mysql: {
+    type: 'sequelize',
+    connected: true,
+    consecutiveFailures: 0
+  }
+}
+```
+
+---
+
+## 📝 Complete Integration Example
+
+```javascript
+const express = require('express');
+const { Sequelize } = require('sequelize');
+const NodeMonitor = require('pms_md');
+
+// Initialize Sequelize
+const sequelize = new Sequelize('asset_tracking', 'root', 'password', {
+  host: 'localhost',
+  dialect: 'mysql'
+});
+
+// Initialize Monitor
+const monitor = new NodeMonitor({
+  app: {
+    name: 'RFID Asset Tracking',
+    version: '1.0.0'
+  },
+  notifications: {
+    email: {
+      enabled: true,
+      host: 'smtp.gmail.com',
+      port: 587,
+      auth: {
+        user: 'manish.proses@gmail.com',
+        pass: process.env.EMAIL_APP_PASSWORD
+      },
+      recipients: ['manish.proses@gmail.com']
+    }
+  }
+});
+
+const app = express();
+app.use(express.json());
+
+// Add monitoring middleware
+app.use(monitor.requestLogger());
+
+// Health check endpoint
+app.get('/health', monitor.healthCheckEndpoint());
+
+// Dashboard endpoint
+app.get('/admin/dashboard', monitor.dashboardEndpoint());
+
+// Your routes
+app.get('/api/assets', monitor.asyncHandler(async (req, res) => {
+  const assets = await Asset.findAll();
+  res.json(assets);
+}));
+
+// Error handling
+app.use(monitor.notFoundHandler());
+app.use(monitor.errorMiddleware());
+
+// Start server
+async function start() {
+  try {
+    // Connect to database
+    await sequelize.authenticate();
+    console.log('✅ Database connected');
+
+    // Register for monitoring
+    monitor.registerDatabase('mysql', 'sequelize', sequelize);
+
+    // Start server
+    const server = app.listen(9025, () => {
+      console.log('✅ Server running on port 9025');
+      
+      // Start monitoring
+      monitor.start();
+      
+      // Graceful shutdown
+      monitor.setupGracefulShutdown(server, async () => {
+        await sequelize.close();
+      });
+    });
+  } catch (error) {
+    console.error('❌ Failed to start:', error);
+    process.exit(1);
+  }
+}
+
+start();
+```
+
+---
+
+## 📊 What You'll Get
+
+### Email Notifications for:
+- ❌ Database connection lost
+- ✅ Database connection restored
+- ⚠️ Multiple consecutive connection failures
+- 🔥 Server errors and API errors
+
+### Monitoring Dashboard:
+- 📈 Real-time database connection status
+- 📊 Connection pool statistics
+- 💾 Database health metrics
+- 🔍 Error logs and tracking
+
+### Log Files:
+- `logs/application-*.log` - All application logs
+- `logs/error-*.log` - Error logs only
+- `logs/combined-*.log` - Combined logs
+
+---
+
+## 🛠️ Configuration Options
+
+```javascript
+const monitor = new NodeMonitor({
+  database: {
+    enabled: true,              // Enable database monitoring
+    queryTimeout: 5000          // Query timeout in ms
+  },
+  intervals: {
+    database: 60000             // Check every 60 seconds
+  },
+  thresholds: {
+    consecutiveFailures: 3      // Alert after 3 failures
+  }
+});
+```
+
+---
+
+## 📚 Documentation
+
+- **Full Guide**: `node_modules/pms_md/node-monitor/examples/MYSQL_SEQUELIZE_GUIDE.md`
+- **Example Code**: `node_modules/pms_md/node-monitor/examples/sequelize-mysql-example.js`
+- **README**: `node_modules/pms_md/node-monitor/README.md`
+- **Getting Started**: `node_modules/pms_md/node-monitor/GETTING_STARTED.md`
+
+---
+
+## ✅ Verified Working
+
+- ✅ Package loads successfully
+- ✅ Sequelize support available
+- ✅ MySQL2 support available
+- ✅ All monitoring features functional
+- ✅ Email notifications configured
+
+---
+
+## 🎯 Next Steps
+
+1. **Integrate into your RFID app** - Add the monitoring code to your server
+2. **Test email notifications** - Trigger an error to test alerts
+3. **Access dashboard** - Visit `/admin/dashboard` to see metrics
+4. **Monitor logs** - Check `logs/` directory for application logs
+
+---
+
+## 💡 Tips
+
+- Use environment variables for sensitive data (email passwords, DB credentials)
+- Adjust monitoring intervals based on your needs
+- Set up Slack notifications for team alerts
+- Monitor the logs directory to ensure everything is working
+
+---
+
+**Package Version**: 1.0.2  
+**Status**: ✅ Ready to use  
+**Support**: MySQL2, Sequelize, PostgreSQL, MongoDB, Redis
+

package/index.js

@@ -0,0 +1,14 @@
+/**
+ * PMS_MD - Node Monitor Package
+ * Main entry point
+ * 
+ * This package provides comprehensive monitoring solution for Node.js applications
+ * with error tracking, health checks, and multi-channel notifications.
+ * 
+ * @author Manish Desai
+ * @license ISC
+ */
+
+// Export the main NodeMonitor class and all components
+module.exports = require('./node-monitor/src/index');
+

package/node-monitor/GETTING_STARTED.md

@@ -211,6 +211,41 @@ const pool = new Pool({
 monitor.registerDatabase('postgres', 'postgresql', pool);
 ```
 
+**MySQL2 Example**:
+
+```javascript
+const mysql = require('mysql2/promise');
+
+const pool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: 'password',
+  database: 'myapp',
+  waitForConnections: true,
+  connectionLimit: 10
+});
+
+monitor.registerDatabase('mysql', 'mysql2', pool);
+```
+
+**Sequelize Example** (Works with MySQL, PostgreSQL, SQLite, MSSQL):
+
+```javascript
+const { Sequelize } = require('sequelize');
+
+const sequelize = new Sequelize('database', 'username', 'password', {
+  host: 'localhost',
+  dialect: 'mysql', // or 'postgres', 'sqlite', 'mssql'
+  logging: false
+});
+
+// Test connection
+await sequelize.authenticate();
+
+// Register for monitoring
+monitor.registerDatabase('mydb', 'sequelize', sequelize);
+```
+
 ### Add Custom Health Checks
 
 ```javascript

package/node-monitor/README.md

@@ -230,10 +230,28 @@ const { Pool } = require('pg');
 const pgPool = new Pool({ connectionString: 'postgresql://...' });
 monitor.registerDatabase('postgres', 'postgresql', pgPool);
 
-// MySQL
+// MySQL2 (Promise-based)
 const mysql = require('mysql2/promise');
-const mysqlPool = mysql.createPool({ /* config */ });
-monitor.registerDatabase('mysql', 'mysql', mysqlPool);
+const mysqlPool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: 'password',
+  database: 'myapp'
+});
+monitor.registerDatabase('mysql', 'mysql2', mysqlPool);
+
+// MySQL2 (Callback-based)
+const mysql2 = require('mysql2');
+const mysqlConnection = mysql2.createConnection({ /* config */ });
+monitor.registerDatabase('mysql', 'mysql2', mysqlConnection);
+
+// Sequelize (ORM for MySQL, PostgreSQL, SQLite, MSSQL)
+const { Sequelize } = require('sequelize');
+const sequelize = new Sequelize('database', 'username', 'password', {
+  host: 'localhost',
+  dialect: 'mysql' // or 'postgres', 'sqlite', 'mssql'
+});
+monitor.registerDatabase('mydb', 'sequelize', sequelize);
 
 // Redis
 const Redis = require('ioredis');