pms_md 1.0.0

package/node-monitor/examples/express-app.js

@@ -0,0 +1,499 @@
+/**
+ * Example Express Application with Node Monitor
+ * Demonstrates how to integrate the monitoring package
+ */
+
+// Load environment variables
+require('dotenv').config();
+
+const express = require('express');
+const path = require('path');
+const NodeMonitor = require('../src/index');
+
+// Initialize the monitor with custom configuration
+const monitor = new NodeMonitor({
+  app: {
+    name: 'Example Express App',
+    version: '1.0.0',
+    environment: process.env.NODE_ENV || 'development'
+  },
+  
+  intervals: {
+    health: 30000,      // Check health every 30 seconds
+    system: 60000,      // Check system resources every minute
+    database: 60000     // Check database every minute
+  },
+  
+  thresholds: {
+    cpu: 75,            // Alert if CPU > 75%
+    memory: 85,         // Alert if memory > 85%
+    errorRate: 10,      // Alert if > 10 errors per minute
+    responseTime: 3000, // Alert if response time > 3 seconds
+    consecutiveFailures: 2
+  },
+  
+  notifications: {
+    enabled: true,
+    cooldown: 180000,   // 3 minutes between alerts
+
+    email: {
+      enabled: true,
+      host: 'smtp.gmail.com',
+      port: 587,
+      secure: false,
+      auth: {
+        user: 'manish.proses@gmail.com',
+        pass: process.env.EMAIL_APP_PASSWORD || 'your-app-password-here'
+      },
+      from: 'manish.proses@gmail.com',
+      recipients: ['manish.proses@gmail.com']
+    },
+    
+    slack: {
+      enabled: false,   // Set to true and configure to enable
+      // webhook: 'https://hooks.slack.com/services/YOUR/WEBHOOK/URL',
+      // channel: '#monitoring'
+    }
+  },
+  
+  logging: {
+    enabled: true,
+    level: 'info',
+    directory: './logs',
+    console: true
+  }
+});
+
+// Create Express app
+const app = express();
+const PORT = process.env.PORT || 3001;
+
+// ============================================
+// SETUP VIEW ENGINE (EJS)
+// ============================================
+app.set('view engine', 'ejs');
+app.set('views', path.join(__dirname, 'views'));
+
+// Serve static files (CSS, JS, images)
+app.use(express.static(path.join(__dirname, 'public')));
+
+// Middleware
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+// Add request logger (optional - logs slow requests)
+app.use(monitor.requestLogger());
+
+// ============================================
+// MONITORING ENDPOINTS
+// ============================================
+
+// Health check endpoint (HTML or JSON)
+app.get('/health', (req, res) => {
+  const acceptsJson = req.headers.accept && req.headers.accept.includes('application/json');
+  const isApiRequest = req.query.format === 'json' || acceptsJson;
+
+  if (!isApiRequest) {
+    // Default to HTML for browser requests
+    return res.render('health', {
+      title: 'Health Check',
+      headerIcon: '💚',
+      headerTitle: 'Health Check',
+      subtitle: 'System health status and monitoring',
+      currentPage: 'health',
+      includeCharts: false,
+      pageScript: 'health.js'
+    });
+  }
+
+  // Return JSON for API requests
+  monitor.healthCheckEndpoint()(req, res);
+});
+
+// Basic health info
+app.get('/health/info', monitor.healthInfoEndpoint());
+
+// Monitoring dashboard (HTML or JSON)
+app.get('/monitor/dashboard', (req, res) => {
+  const acceptsJson = req.headers.accept && req.headers.accept.includes('application/json');
+  const isApiRequest = req.query.format === 'json' || acceptsJson;
+
+  if (!isApiRequest) {
+    // Default to HTML for browser requests
+    return res.render('dashboard', {
+      title: 'Dashboard',
+      headerIcon: '📊',
+      headerTitle: 'Monitoring Dashboard',
+      subtitle: 'Real-time application monitoring and analytics',
+      currentPage: 'dashboard',
+      includeCharts: false,
+      pageScript: 'dashboard.js'
+    });
+  }
+
+  // Return JSON for API requests
+  monitor.dashboardEndpoint()(req, res);
+});
+
+// Get current monitoring status
+// Get status (HTML or JSON)
+app.get('/monitor/status', (req, res) => {
+  const acceptsJson = req.headers.accept && req.headers.accept.includes('application/json');
+  const isApiRequest = req.query.format === 'json' || acceptsJson;
+
+  if (!isApiRequest) {
+    // Default to HTML for browser requests
+    return res.render('status', {
+      title: 'API Status',
+      headerIcon: '📋',
+      headerTitle: 'API Status',
+      subtitle: 'Real-time application status and metrics',
+      currentPage: 'status'
+    });
+  }
+
+  // Return JSON for API requests
+  res.json(monitor.getStatus());
+});
+
+// Get system information
+app.get('/monitor/system', (req, res) => {
+  res.json(monitor.getSystemInfo());
+});
+
+// Get metrics history (HTML or JSON)
+app.get('/monitor/metrics', (req, res) => {
+  const acceptsJson = req.headers.accept && req.headers.accept.includes('application/json');
+  const isApiRequest = req.query.format === 'json' || acceptsJson;
+
+  if (!isApiRequest) {
+    // Default to HTML for browser requests
+    return res.render('metrics', {
+      title: 'Metrics',
+      headerIcon: '📈',
+      headerTitle: 'System Metrics',
+      subtitle: 'Performance monitoring and analytics',
+      currentPage: 'metrics',
+      includeCharts: true,
+      pageScript: 'metrics.js'
+    });
+  }
+
+  // Return JSON for API requests
+  res.json({
+    timestamp: new Date().toISOString(),
+    history: monitor.getMetricsHistory()
+  });
+});
+
+// ============================================
+// EXAMPLE APPLICATION ROUTES
+// ============================================
+
+// Home route
+app.get('/', (req, res) => {
+  const acceptsJson = req.headers.accept && req.headers.accept.includes('application/json');
+  const isApiRequest = req.query.format === 'json' || acceptsJson;
+
+  if (!isApiRequest) {
+    // Default to HTML for browser requests
+    return res.render('home', {
+      title: 'Home',
+      headerIcon: '🏠',
+      headerTitle: 'Node Monitor',
+      subtitle: null,
+      currentPage: 'home',
+      includeCharts: false,
+      pageScript: null
+    });
+  }
+
+  // Return JSON for API clients
+  res.json({
+    message: 'Welcome to Node Monitor Example App',
+    endpoints: {
+      home: '/',
+      health: '/health',
+      healthInfo: '/health/info',
+      dashboard: '/monitor/dashboard',
+      status: '/monitor/status',
+      system: '/monitor/system',
+      metrics: '/monitor/metrics',
+      examples: {
+        success: '/api/success',
+        error: '/api/error',
+        slow: '/api/slow',
+        customNotification: '/api/notify'
+      }
+    }
+  });
+});
+
+// Remove the old inline HTML (keeping this comment for reference)
+/*
+// Old home route with inline HTML - now replaced with EJS
+app.get('/', (req, res) => {
+  const acceptsHtml = req.headers.accept && req.headers.accept.includes('text/html');
+
+  if (acceptsHtml) {
+    // Serve HTML landing page
+    res.send(`
+*/
+
+// Success endpoint
+app.get('/api/success', (req, res) => {
+  monitor.logInfo('Success endpoint called');
+  res.json({ message: 'Success!' });
+});
+
+// Error endpoint (demonstrates error tracking)
+app.get('/api/error', (req, res, next) => {
+  const error = NodeMonitor.createError('This is a test error', 500, {
+    testData: 'example'
+  });
+  next(error);
+});
+
+// Slow endpoint (demonstrates slow request tracking)
+app.get('/api/slow', monitor.asyncHandler(async (req, res) => {
+  // Simulate slow operation
+  await new Promise(resolve => setTimeout(resolve, 4000));
+  res.json({ message: 'This was a slow request' });
+}));
+
+// Test notification endpoint (GET request for easy testing)
+app.get('/api/notify-test', monitor.asyncHandler(async (req, res) => {
+  const result = await monitor.notify(
+    'info',
+    'Test Notification',
+    'This is a test email notification from Node Monitor. If you received this, your email configuration is working correctly!',
+    {
+      testTime: new Date().toISOString(),
+      recipient: 'manish.proses@gmail.com',
+      status: 'Email configuration is working! ✅'
+    }
+  );
+
+  res.json({
+    message: 'Test notification sent!',
+    result,
+    instructions: 'Check your email inbox at manish.proses@gmail.com'
+  });
+}));
+
+// Custom notification endpoint (POST)
+app.post('/api/notify', monitor.asyncHandler(async (req, res) => {
+  const { level, subject, message, details } = req.body;
+
+  const result = await monitor.notify(
+    level || 'info',
+    subject || 'Test Notification',
+    message || 'This is a test notification',
+    details || {}
+  );
+
+  res.json({
+    message: 'Notification sent',
+    result
+  });
+}));
+
+// Error logs viewer endpoint
+app.get('/monitor/error-logs', monitor.asyncHandler(async (req, res) => {
+  const fs = require('fs');
+  const path = require('path');
+
+  const logsDir = path.join(__dirname, 'logs');
+  const { date, format } = req.query;
+
+  try {
+    // Ensure logs directory exists
+    if (!fs.existsSync(logsDir)) {
+      fs.mkdirSync(logsDir, { recursive: true });
+    }
+
+    // Get list of error log files
+    const files = fs.readdirSync(logsDir)
+      .filter(f => f.startsWith('error-') && f.endsWith('.log'))
+      .sort()
+      .reverse();
+
+    if (format === 'json') {
+      // Return list of available log files
+      const logFiles = files.map(f => {
+        const stats = fs.statSync(path.join(logsDir, f));
+        return {
+          filename: f,
+          date: f.replace('error-', '').replace('.log', ''),
+          size: stats.size,
+          modified: stats.mtime
+        };
+      });
+
+      return res.json({ files: logFiles });
+    }
+
+    // Render HTML view
+    res.render('error-logs', {
+      title: 'API Error Logs',
+      headerIcon: '📋',
+      headerTitle: 'API Error Logs',
+      subtitle: 'View and analyze API errors',
+      currentPage: 'error-logs',
+      files: files.length > 0 ? files : []
+    });
+  } catch (error) {
+    res.status(500).json({ error: error.message });
+  }
+}));
+
+// Get specific error log file content
+app.get('/monitor/error-logs/:filename', monitor.asyncHandler(async (req, res) => {
+  const fs = require('fs');
+  const path = require('path');
+  const { filename } = req.params;
+  const { format, limit = 100 } = req.query;
+
+  // Security: only allow error log files
+  if (!filename.startsWith('error-') || !filename.endsWith('.log')) {
+    return res.status(400).json({ error: 'Invalid log file' });
+  }
+
+  const logPath = path.join(__dirname, 'logs', filename);
+
+  if (!fs.existsSync(logPath)) {
+    return res.status(404).json({ error: 'Log file not found' });
+  }
+
+  try {
+    const content = fs.readFileSync(logPath, 'utf8');
+    const lines = content.trim().split('\n').filter(line => line.trim());
+
+    // Parse JSON logs
+    const errors = lines
+      .map((line, index) => {
+        try {
+          return JSON.parse(line);
+        } catch (e) {
+          return null;
+        }
+      })
+      .filter(e => e !== null)
+      .reverse() // Most recent first
+      .slice(0, parseInt(limit));
+
+    if (format === 'json') {
+      return res.json({
+        filename,
+        total: lines.length,
+        errors
+      });
+    }
+
+    // Return raw content for download
+    res.setHeader('Content-Type', 'application/json');
+    res.setHeader('Content-Disposition', `attachment; filename="${filename}"`);
+    res.send(content);
+  } catch (error) {
+    res.status(500).json({ error: error.message });
+  }
+}));
+
+// Async error example
+app.get('/api/async-error', monitor.asyncHandler(async (req, res) => {
+  // This error will be caught by asyncHandler
+  throw new Error('Async operation failed');
+}));
+
+// Database simulation endpoint
+app.get('/api/db-test', monitor.asyncHandler(async (req, res) => {
+  // In a real app, you would query your database here
+  monitor.logInfo('Database query simulated');
+  res.json({ message: 'Database query successful' });
+}));
+
+// ============================================
+// CUSTOM HEALTH CHECKS
+// ============================================
+
+// Register custom health check
+monitor.registerHealthCheck('api-responsive', async () => {
+  // Check if API is responsive
+  return true; // Return true if healthy, false if not
+});
+
+monitor.registerHealthCheck('external-service', async () => {
+  // Example: Check external service availability
+  try {
+    // const response = await axios.get('https://api.example.com/health');
+    // return response.status === 200;
+    return true;
+  } catch {
+    return false;
+  }
+});
+
+// ============================================
+// DATABASE MONITORING (EXAMPLE)
+// ============================================
+
+// Uncomment and configure based on your database
+
+// MongoDB/Mongoose example:
+// const mongoose = require('mongoose');
+// mongoose.connect('mongodb://localhost:27017/myapp');
+// monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
+
+// PostgreSQL example:
+// const { Pool } = require('pg');
+// const pgPool = new Pool({ connectionString: 'postgresql://...' });
+// monitor.registerDatabase('postgres', 'postgresql', pgPool);
+
+// MySQL example:
+// const mysql = require('mysql2/promise');
+// const mysqlPool = mysql.createPool({ host: 'localhost', user: 'root', database: 'myapp' });
+// monitor.registerDatabase('mysql', 'mysql', mysqlPool);
+
+// Redis example:
+// const Redis = require('ioredis');
+// const redis = new Redis();
+// monitor.registerDatabase('redis', 'redis', redis);
+
+// ============================================
+// ERROR HANDLING
+// ============================================
+
+// 404 handler (must be after all routes)
+app.use(monitor.notFoundHandler());
+
+// Error handler (must be last)
+app.use(monitor.errorMiddleware());
+
+// ============================================
+// START SERVER
+// ============================================
+
+const server = app.listen(PORT, () => {
+  console.log(`\n🚀 Server running on http://localhost:${PORT}`);
+  console.log(`📊 Health check: http://localhost:${PORT}/health`);
+  console.log(`📈 Dashboard: http://localhost:${PORT}/monitor/dashboard`);
+  console.log(`\n✅ Node Monitor is active and monitoring your application\n`);
+  
+  // Start monitoring services
+  monitor.start();
+  
+  // Setup graceful shutdown
+  monitor.setupGracefulShutdown(server);
+});
+
+// Handle server errors
+server.on('error', (error) => {
+  monitor.logError('server_error', 'Server error occurred', {
+    error: error.message,
+    code: error.code
+  });
+});
+
+// Export for testing
+module.exports = { app, monitor, server };
+