pms_md 1.0.4 → 1.0.5

package/DATABASE_SUPPORT.md

@@ -1,582 +0,0 @@
-# 🗄️ Complete Database Support Guide
-
-## ✅ Supported Databases (v1.0.3)
-
-The `pms_md` package now supports **15+ database types** with automatic health monitoring, connection checks, and statistics tracking.
-
----
-
-## 📊 Database Support Matrix
-
-| Database | Type | Package | Status | Stats Support |
-|----------|------|---------|--------|---------------|
-| **MongoDB** | NoSQL | `mongoose` or `mongodb` | ✅ Full | ✅ Yes |
-| **PostgreSQL** | SQL | `pg` | ✅ Full | ✅ Yes |
-| **MySQL** | SQL | `mysql2` | ✅ Full | ✅ Yes |
-| **MariaDB** | SQL | `mariadb` | ✅ Full | ✅ Yes |
-| **MSSQL** | SQL | `mssql` or `tedious` | ✅ Full | ✅ Yes |
-| **SQLite** | SQL | `sqlite3` or `better-sqlite3` | ✅ Full | ✅ Yes |
-| **Sequelize** | ORM | `sequelize` | ✅ Full | ✅ Yes |
-| **Redis** | Cache | `ioredis` | ✅ Full | ✅ Yes |
-| **CouchDB** | NoSQL | `nano` | ✅ Full | ✅ Yes |
-| **Cassandra** | NoSQL | `cassandra-driver` | ✅ Full | ✅ Yes |
-| **Elasticsearch** | Search | `@elastic/elasticsearch` | ✅ Full | ✅ Yes |
-| **DynamoDB** | NoSQL | `@aws-sdk/client-dynamodb` or `aws-sdk` | ✅ Full | ✅ Yes |
-| **Neo4j** | Graph | `neo4j-driver` | ✅ Full | ✅ Yes |
-
----
-
-## 🚀 Quick Start Examples
-
-### 1. MongoDB / Mongoose
-
-```javascript
-const mongoose = require('mongoose');
-const NodeMonitor = require('pms_md');
-
-await mongoose.connect('mongodb://localhost:27017/mydb');
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
-monitor.start();
-```
-
-### 2. PostgreSQL
-
-```javascript
-const { Pool } = require('pg');
-const NodeMonitor = require('pms_md');
-
-const pool = new Pool({
-  host: 'localhost',
-  database: 'mydb',
-  user: 'postgres',
-  password: 'password'
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('postgres', 'postgresql', pool);
-monitor.start();
-```
-
-### 3. MySQL / MySQL2
-
-```javascript
-const mysql = require('mysql2/promise');
-const NodeMonitor = require('pms_md');
-
-const pool = mysql.createPool({
-  host: 'localhost',
-  user: 'root',
-  password: 'password',
-  database: 'mydb'
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('mysql', 'mysql2', pool);
-monitor.start();
-```
-
-### 4. MariaDB
-
-```javascript
-const mariadb = require('mariadb');
-const NodeMonitor = require('pms_md');
-
-const pool = mariadb.createPool({
-  host: 'localhost',
-  user: 'root',
-  password: 'password',
-  database: 'mydb'
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('mariadb', 'mariadb', pool);
-monitor.start();
-```
-
-### 5. MSSQL (Microsoft SQL Server)
-
-```javascript
-const sql = require('mssql');
-const NodeMonitor = require('pms_md');
-
-const pool = await sql.connect({
-  server: 'localhost',
-  database: 'mydb',
-  user: 'sa',
-  password: 'YourPassword123',
-  options: {
-    encrypt: true,
-    trustServerCertificate: true
-  }
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('mssql', 'mssql', pool);
-monitor.start();
-```
-
-### 6. SQLite
-
-```javascript
-// Option A: sqlite3
-const sqlite3 = require('sqlite3').verbose();
-const NodeMonitor = require('pms_md');
-
-const db = new sqlite3.Database('./mydb.sqlite');
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('sqlite', 'sqlite3', db);
-monitor.start();
-
-// Option B: better-sqlite3
-const Database = require('better-sqlite3');
-const db = new Database('./mydb.sqlite');
-
-monitor.registerDatabase('sqlite', 'sqlite3', db);
-```
-
-### 7. Sequelize (Multi-Database ORM)
-
-```javascript
-const { Sequelize } = require('sequelize');
-const NodeMonitor = require('pms_md');
-
-// Works with MySQL, PostgreSQL, SQLite, MSSQL
-const sequelize = new Sequelize('database', 'username', 'password', {
-  host: 'localhost',
-  dialect: 'mysql' // or 'postgres', 'sqlite', 'mssql'
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('mydb', 'sequelize', sequelize);
-monitor.start();
-```
-
-### 8. Redis
-
-```javascript
-const Redis = require('ioredis');
-const NodeMonitor = require('pms_md');
-
-const redis = new Redis({
-  host: 'localhost',
-  port: 6379,
-  password: 'your-password'
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('redis', 'redis', redis);
-monitor.start();
-```
-
-### 9. CouchDB
-
-```javascript
-const nano = require('nano');
-const NodeMonitor = require('pms_md');
-
-const couch = nano('http://admin:password@localhost:5984');
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('couchdb', 'nano', couch);
-monitor.start();
-```
-
-### 10. Cassandra
-
-```javascript
-const cassandra = require('cassandra-driver');
-const NodeMonitor = require('pms_md');
-
-const client = new cassandra.Client({
-  contactPoints: ['localhost'],
-  localDataCenter: 'datacenter1',
-  keyspace: 'mykeyspace'
-});
-
-await client.connect();
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('cassandra', 'cassandra', client);
-monitor.start();
-```
-
-### 11. Elasticsearch
-
-```javascript
-const { Client } = require('@elastic/elasticsearch');
-const NodeMonitor = require('pms_md');
-
-const client = new Client({
-  node: 'http://localhost:9200',
-  auth: {
-    username: 'elastic',
-    password: 'password'
-  }
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('elasticsearch', 'elasticsearch', client);
-monitor.start();
-```
-
-### 12. DynamoDB
-
-```javascript
-// AWS SDK v3 (Recommended)
-const { DynamoDBClient } = require('@aws-sdk/client-dynamodb');
-const NodeMonitor = require('pms_md');
-
-const client = new DynamoDBClient({
-  region: 'us-east-1',
-  credentials: {
-    accessKeyId: 'YOUR_ACCESS_KEY',
-    secretAccessKey: 'YOUR_SECRET_KEY'
-  }
-});
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('dynamodb', 'dynamodb', client);
-monitor.start();
-
-// AWS SDK v2
-const AWS = require('aws-sdk');
-const dynamodb = new AWS.DynamoDB({ region: 'us-east-1' });
-monitor.registerDatabase('dynamodb', 'dynamodb', dynamodb);
-```
-
-### 13. Neo4j
-
-```javascript
-const neo4j = require('neo4j-driver');
-const NodeMonitor = require('pms_md');
-
-const driver = neo4j.driver(
-  'bolt://localhost:7687',
-  neo4j.auth.basic('neo4j', 'password')
-);
-
-const monitor = new NodeMonitor();
-monitor.registerDatabase('neo4j', 'neo4j', driver);
-monitor.start();
-
-// Don't forget to close the driver when done
-// await driver.close();
-```
-
----
-
-## 📊 Getting Database Statistics
-
-```javascript
-// Get stats for any registered database
-const stats = await monitor.getDatabaseStats('database-name');
-
-// MongoDB stats
-{
-  type: 'mongodb',
-  collections: 10,
-  dataSize: 1048576,
-  indexes: 15,
-  indexSize: 204800
-}
-
-// PostgreSQL stats
-{
-  type: 'postgresql',
-  activeConnections: 5
-}
-
-// MySQL/MariaDB stats
-{
-  type: 'mysql',
-  threadsConnected: 3
-}
-
-// MSSQL stats
-{
-  type: 'mssql',
-  version: 'Microsoft SQL Server 2019...',
-  connections: 10,
-  connected: true
-}
-
-// SQLite stats
-{
-  type: 'sqlite',
-  database: '/path/to/mydb.sqlite',
-  inTransaction: false
-}
-
-// Redis stats
-{
-  type: 'redis',
-  connectedClients: '2',
-  usedMemory: '1.5M',
-  uptime: '86400'
-}
-
-// Cassandra stats
-{
-  type: 'cassandra',
-  connectedHosts: 3,
-  hosts: ['192.168.1.1', '192.168.1.2', '192.168.1.3'],
-  keyspaces: 5
-}
-
-// Elasticsearch stats
-{
-  type: 'elasticsearch',
-  clusterName: 'my-cluster',
-  status: 'green',
-  numberOfNodes: 3,
-  activeShards: 10,
-  version: '8.5.0'
-}
-
-// DynamoDB stats
-{
-  type: 'dynamodb',
-  tableCount: 15
-}
-
-// Neo4j stats
-{
-  type: 'neo4j',
-  version: '5.0.0',
-  address: 'localhost:7687',
-  edition: 'community'
-}
-```
-
----
-
-## 🔔 Automatic Monitoring Features
-
-All registered databases get:
-
-### ✅ Connection Health Checks
-- Automatic periodic connection checks (every 1 minute by default)
-- Configurable check intervals
-
-### ✅ Email Notifications
-- **Connection Lost**: Critical alert when database connection fails
-- **Connection Restored**: Recovery notification when connection is back
-- Consecutive failure tracking
-
-### ✅ Logging
-- All connection checks logged with Winston
-- Error details captured and logged
-- System-wide monitoring integration
-
-### ✅ Health Endpoints
-```javascript
-// Check all database statuses
-app.get('/health', monitor.healthCheckEndpoint());
-
-// Get detailed health info
-app.get('/health/info', monitor.healthInfoEndpoint());
-
-// Get monitoring status
-const status = monitor.getStatus();
-console.log(status.databases);
-// {
-//   mongodb: { type: 'mongoose', connected: true, consecutiveFailures: 0 },
-//   postgres: { type: 'postgresql', connected: true, consecutiveFailures: 0 },
-//   mssql: { type: 'mssql', connected: true, consecutiveFailures: 0 }
-// }
-```
-
----
-
-## 📦 Installation
-
-Install only the database drivers you need:
-
-```bash
-# Core package
-npm install pms_md
-
-# MongoDB
-npm install mongoose
-
-# PostgreSQL
-npm install pg
-
-# MySQL
-npm install mysql2
-
-# MariaDB
-npm install mariadb
-
-# MSSQL
-npm install mssql
-# or
-npm install tedious
-
-# SQLite
-npm install sqlite3
-# or
-npm install better-sqlite3
-
-# Sequelize (ORM)
-npm install sequelize
-
-# Redis
-npm install ioredis
-
-# CouchDB
-npm install nano
-
-# Cassandra
-npm install cassandra-driver
-
-# Elasticsearch
-npm install @elastic/elasticsearch
-
-# DynamoDB
-npm install @aws-sdk/client-dynamodb
-# or
-npm install aws-sdk
-
-# Neo4j
-npm install neo4j-driver
-```
-
----
-
-## ⚙️ Configuration
-
-```javascript
-const monitor = new NodeMonitor({
-  database: {
-    enabled: true,
-    queryTimeout: 5000 // 5 seconds timeout for health checks
-  },
-  intervals: {
-    database: 60000 // Check every 60 seconds (1 minute)
-  },
-  thresholds: {
-    consecutiveFailures: 3 // Send alert after 3 consecutive failures
-  },
-  notifications: {
-    email: {
-      enabled: true,
-      recipients: ['admin@example.com']
-    }
-  }
-});
-```
-
----
-
-## 🎯 Best Practices
-
-1. **Register databases after connection**: Always register databases after they're successfully connected
-2. **Use connection pools**: For SQL databases, use connection pools for better performance
-3. **Handle errors**: Wrap database connections in try-catch blocks
-4. **Monitor in production**: Enable monitoring in production environments
-5. **Set appropriate timeouts**: Configure query timeouts based on your database performance
-6. **Use health endpoints**: Integrate health endpoints with load balancers and orchestrators
-
----
-
-## 📝 Example: Multi-Database Application
-
-```javascript
-const NodeMonitor = require('pms_md');
-const mongoose = require('mongoose');
-const { Pool } = require('pg');
-const Redis = require('ioredis');
-const sql = require('mssql');
-
-// Initialize monitor
-const monitor = new NodeMonitor({
-  notifications: {
-    email: {
-      enabled: true,
-      recipients: ['admin@example.com']
-    }
-  }
-});
-
-// Connect to MongoDB
-await mongoose.connect('mongodb://localhost:27017/myapp');
-monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
-
-// Connect to PostgreSQL
-const pgPool = new Pool({ connectionString: 'postgresql://...' });
-monitor.registerDatabase('postgres', 'postgresql', pgPool);
-
-// Connect to Redis
-const redis = new Redis();
-monitor.registerDatabase('redis', 'redis', redis);
-
-// Connect to MSSQL
-const mssqlPool = await sql.connect({ server: 'localhost', database: 'mydb' });
-monitor.registerDatabase('mssql', 'mssql', mssqlPool);
-
-// Start monitoring all databases
-monitor.start();
-
-// Express app
-const app = express();
-app.use(monitor.requestLogger());
-app.get('/health', monitor.healthCheckEndpoint());
-
-// Graceful shutdown
-const server = app.listen(3000);
-monitor.setupGracefulShutdown(server);
-```
-
----
-
-## 🆘 Troubleshooting
-
-### Database not connecting?
-- Check connection credentials
-- Verify database server is running
-- Check firewall rules
-- Review connection timeout settings
-
-### Not receiving alerts?
-- Verify email configuration in `.env`
-- Check `consecutiveFailures` threshold
-- Review notification settings
-- Check email logs
-
-### Stats not working?
-- Ensure database user has proper permissions
-- Some stats require admin/elevated privileges
-- Check database-specific documentation
-
----
-
-## 📚 Additional Resources
-
-- [Main README](README.md)
-- [MySQL2 & Sequelize Guide](MYSQL2_SEQUELIZE_SUPPORT.md)
-- [Package Analysis](PACKAGE_ANALYSIS.md)
-- [Setup Guide](node-monitor/SETUP_GUIDE.md)
-
----
-
-## 🎉 Summary
-
-**Version 1.0.3** adds support for:
-- ✅ MSSQL (Microsoft SQL Server)
-- ✅ MariaDB
-- ✅ SQLite
-- ✅ CouchDB
-- ✅ Cassandra
-- ✅ Elasticsearch
-- ✅ DynamoDB
-- ✅ Neo4j
-
-**Total: 13+ database types supported!**
-
-All with automatic health monitoring, email notifications, and statistics tracking! 🚀
-
-