pms_md 1.0.0

package/node-monitor/INSTALLATION.md

@@ -0,0 +1,470 @@
+# Installation & Testing Guide
+
+## Installation
+
+### Option 1: Install from npm (When Published)
+
+```bash
+npm install @projectmd/node-monitor
+```
+
+### Option 2: Install from Local Directory (For Development)
+
+```bash
+# From the node-monitor directory
+npm install
+
+# Link the package globally
+npm link
+
+# In your project directory
+npm link @projectmd/node-monitor
+```
+
+### Option 3: Install from Git Repository
+
+```bash
+npm install git+https://github.com/yourorg/node-monitor.git
+```
+
+## Installing Dependencies
+
+### Core Dependencies (Required)
+
+```bash
+cd node-monitor
+npm install
+```
+
+This installs:
+- winston
+- winston-daily-rotate-file
+- nodemailer
+- @slack/webhook
+- axios
+- node-cron
+
+### Peer Dependencies (Optional - Install as Needed)
+
+```bash
+# For Express integration
+npm install express
+
+# For MongoDB monitoring
+npm install mongoose
+
+# For PostgreSQL monitoring
+npm install pg
+
+# For MySQL monitoring
+npm install mysql2
+
+# For Redis monitoring
+npm install ioredis
+```
+
+## Running the Example Application
+
+### Step 1: Install Example Dependencies
+
+```bash
+cd examples
+npm install
+```
+
+### Step 2: Configure Environment (Optional)
+
+```bash
+# Copy the example env file
+cp ../.env.example .env
+
+# Edit .env with your settings
+nano .env
+```
+
+### Step 3: Run the Example
+
+```bash
+npm start
+```
+
+The server will start on http://localhost:3000
+
+### Step 4: Test the Endpoints
+
+```bash
+# Health check
+curl http://localhost:3000/health
+
+# Health info
+curl http://localhost:3000/health/info
+
+# Monitoring dashboard
+curl http://localhost:3000/monitor/dashboard
+
+# Test success endpoint
+curl http://localhost:3000/api/success
+
+# Test error endpoint
+curl http://localhost:3000/api/error
+
+# Test slow endpoint
+curl http://localhost:3000/api/slow
+
+# Test 404
+curl http://localhost:3000/nonexistent
+```
+
+## Testing Notifications
+
+### Test Email Notifications
+
+1. Configure email in `.env`:
+```env
+MONITOR_EMAIL_ENABLED=true
+MONITOR_EMAIL_HOST=smtp.gmail.com
+MONITOR_EMAIL_PORT=587
+MONITOR_EMAIL_USER=your-email@gmail.com
+MONITOR_EMAIL_PASS=your-app-password
+MONITOR_EMAIL_RECIPIENTS=test@example.com
+```
+
+2. Send test notification:
+```bash
+curl -X POST http://localhost:3000/api/notify \
+  -H "Content-Type: application/json" \
+  -d '{
+    "level": "info",
+    "subject": "Test Email",
+    "message": "This is a test email notification"
+  }'
+```
+
+### Test Slack Notifications
+
+1. Configure Slack in `.env`:
+```env
+MONITOR_SLACK_ENABLED=true
+MONITOR_SLACK_WEBHOOK=https://hooks.slack.com/services/YOUR/WEBHOOK
+```
+
+2. Send test notification:
+```bash
+curl -X POST http://localhost:3000/api/notify \
+  -H "Content-Type: application/json" \
+  -d '{
+    "level": "warning",
+    "subject": "Test Slack",
+    "message": "This is a test Slack notification"
+  }'
+```
+
+## Testing Database Monitoring
+
+### MongoDB Example
+
+```javascript
+// In examples/express-app.js, uncomment:
+const mongoose = require('mongoose');
+await mongoose.connect('mongodb://localhost:27017/test');
+monitor.registerDatabase('mongodb', 'mongoose', mongoose.connection);
+```
+
+### PostgreSQL Example
+
+```javascript
+const { Pool } = require('pg');
+const pool = new Pool({ connectionString: 'postgresql://localhost/test' });
+monitor.registerDatabase('postgres', 'postgresql', pool);
+```
+
+## Verifying Installation
+
+### Check Logs
+
+```bash
+# View application logs
+ls -la logs/
+
+# View latest application log
+tail -f logs/application-*.log
+
+# View latest error log
+tail -f logs/error-*.log
+```
+
+### Check Monitoring Status
+
+```bash
+curl http://localhost:3000/monitor/status | jq
+```
+
+Expected output:
+```json
+{
+  "isRunning": true,
+  "health": {
+    "isHealthy": true,
+    "uptime": "0d 0h 5m 30s",
+    "consecutiveFailures": 0,
+    "registeredChecks": 2
+  },
+  "system": {
+    "cpu": { "process": 2.5, "system": 15.3 },
+    "memory": { ... }
+  },
+  "databases": {},
+  "errors": {
+    "currentErrorRate": 0,
+    "threshold": 10,
+    "apiErrorRate": 0
+  }
+}
+```
+
+## Performance Testing
+
+### Load Testing with Apache Bench
+
+```bash
+# Install Apache Bench
+sudo apt-get install apache2-utils  # Ubuntu/Debian
+brew install httpd                   # macOS
+
+# Run load test
+ab -n 1000 -c 10 http://localhost:3000/
+```
+
+### Load Testing with Artillery
+
+```bash
+# Install Artillery
+npm install -g artillery
+
+# Create test config (artillery.yml)
+cat > artillery.yml << EOF
+config:
+  target: 'http://localhost:3000'
+  phases:
+    - duration: 60
+      arrivalRate: 10
+scenarios:
+  - flow:
+      - get:
+          url: "/"
+      - get:
+          url: "/health"
+EOF
+
+# Run test
+artillery run artillery.yml
+```
+
+## Troubleshooting Installation
+
+### Issue: Module not found
+
+**Solution**: Ensure all dependencies are installed
+```bash
+npm install
+```
+
+### Issue: Permission denied on logs directory
+
+**Solution**: Create logs directory with proper permissions
+```bash
+mkdir -p logs
+chmod 755 logs
+```
+
+### Issue: Port 3000 already in use
+
+**Solution**: Use a different port
+```bash
+PORT=3001 npm start
+```
+
+Or in code:
+```javascript
+const PORT = process.env.PORT || 3001;
+```
+
+### Issue: Email notifications not working
+
+**Solutions**:
+1. Check SMTP credentials
+2. Enable "Less secure app access" (Gmail)
+3. Use App Password instead of regular password
+4. Check firewall settings
+
+### Issue: Slack notifications not working
+
+**Solutions**:
+1. Verify webhook URL is correct
+2. Check webhook hasn't been revoked
+3. Test webhook with curl:
+```bash
+curl -X POST -H 'Content-type: application/json' \
+  --data '{"text":"Test"}' \
+  YOUR_WEBHOOK_URL
+```
+
+## Development Setup
+
+### For Contributing
+
+```bash
+# Clone the repository
+git clone https://github.com/yourorg/node-monitor.git
+cd node-monitor
+
+# Install dependencies
+npm install
+
+# Link for local development
+npm link
+
+# Run example
+cd examples
+npm install
+npm link @projectmd/node-monitor
+npm start
+```
+
+### Running Tests (When Implemented)
+
+```bash
+# Run all tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+
+# Run tests in watch mode
+npm run test:watch
+```
+
+## Docker Installation
+
+### Build Docker Image
+
+```bash
+# Build the image
+docker build -t node-monitor-example .
+
+# Run the container
+docker run -p 3000:3000 node-monitor-example
+```
+
+### Docker Compose
+
+```bash
+# Start services
+docker-compose up
+
+# Start in background
+docker-compose up -d
+
+# View logs
+docker-compose logs -f
+
+# Stop services
+docker-compose down
+```
+
+## Production Deployment
+
+### Using PM2
+
+```bash
+# Install PM2
+npm install -g pm2
+
+# Start application
+pm2 start examples/express-app.js --name "node-monitor-example"
+
+# View logs
+pm2 logs node-monitor-example
+
+# Monitor
+pm2 monit
+
+# Save configuration
+pm2 save
+
+# Setup startup script
+pm2 startup
+```
+
+### Using systemd (Linux)
+
+Create `/etc/systemd/system/node-monitor.service`:
+
+```ini
+[Unit]
+Description=Node Monitor Example
+After=network.target
+
+[Service]
+Type=simple
+User=nodejs
+WorkingDirectory=/path/to/node-monitor/examples
+ExecStart=/usr/bin/node express-app.js
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Enable and start:
+```bash
+sudo systemctl enable node-monitor
+sudo systemctl start node-monitor
+sudo systemctl status node-monitor
+```
+
+## Verification Checklist
+
+- [ ] Package installed successfully
+- [ ] Example application runs
+- [ ] Health check endpoint responds
+- [ ] Logs are being created
+- [ ] Error tracking works
+- [ ] Email notifications work (if configured)
+- [ ] Slack notifications work (if configured)
+- [ ] Database monitoring works (if configured)
+- [ ] System metrics are being collected
+- [ ] Graceful shutdown works
+
+## Next Steps
+
+After successful installation:
+
+1. ✅ Read the [Getting Started Guide](GETTING_STARTED.md)
+2. ✅ Review the [Setup Guide](SETUP_GUIDE.md)
+3. ✅ Check the [Quick Reference](QUICK_REFERENCE.md)
+4. ✅ Explore the [Architecture](ARCHITECTURE.md)
+5. ✅ Integrate into your application
+
+## Support
+
+If you encounter any issues:
+
+1. Check the [Troubleshooting](#troubleshooting-installation) section
+2. Review the logs in `logs/` directory
+3. Check [GitHub Issues](https://github.com/yourorg/node-monitor/issues)
+4. Create a new issue with details
+
+## Uninstallation
+
+```bash
+# Remove the package
+npm uninstall @projectmd/node-monitor
+
+# Remove logs (optional)
+rm -rf logs/
+
+# Unlink (if using npm link)
+npm unlink @projectmd/node-monitor
+```
+

package/node-monitor/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 ProjectMD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+