pms_md 1.0.0

package/README.md

@@ -0,0 +1,93 @@
+# PMS_MD
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/manish-proses/pms_md.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.com/manish-proses/pms_md/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/node-monitor/ARCHITECTURE.md

@@ -0,0 +1,341 @@
+# Node Monitor - Architecture Overview
+
+## System Architecture
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                        Node Monitor                              │
+│                                                                   │
+│  ┌────────────────────────────────────────────────────────────┐ │
+│  │                   Main Monitor Class                        │ │
+│  │              (Orchestrates all components)                  │ │
+│  └────────────────────────────────────────────────────────────┘ │
+│                              │                                    │
+│         ┌────────────────────┼────────────────────┐             │
+│         │                    │                    │             │
+│         ▼                    ▼                    ▼             │
+│  ┌─────────────┐      ┌─────────────┐     ┌─────────────┐     │
+│  │   Config    │      │   Logger    │     │ Notifier    │     │
+│  │  Manager    │      │   Module    │     │  Manager    │     │
+│  └─────────────┘      └─────────────┘     └─────────────┘     │
+│                                                   │              │
+│                                          ┌────────┼────────┐    │
+│                                          ▼        ▼        ▼    │
+│                                       Email    Slack     SMS    │
+│                                                                  │
+│  ┌──────────────────────────────────────────────────────────┐  │
+│  │                    Monitor Modules                        │  │
+│  │                                                            │  │
+│  │  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐   │  │
+│  │  │ API Error    │  │   Server     │  │   System     │   │  │
+│  │  │  Monitor     │  │   Health     │  │  Resource    │   │  │
+│  │  │              │  │   Monitor    │  │   Monitor    │   │  │
+│  │  └──────────────┘  └──────────────┘  └──────────────┘   │  │
+│  │                                                            │  │
+│  │  ┌──────────────┐                                         │  │
+│  │  │  Database    │                                         │  │
+│  │  │ Connection   │                                         │  │
+│  │  │   Monitor    │                                         │  │
+│  │  └──────────────┘                                         │  │
+│  └──────────────────────────────────────────────────────────┘  │
+└───────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+                    ┌──────────────────┐
+                    │  Your Express    │
+                    │   Application    │
+                    └──────────────────┘
+```
+
+## Component Breakdown
+
+### 1. Configuration Manager (`MonitoringConfig`)
+
+**Responsibilities:**
+- Load configuration from environment variables
+- Merge with user-provided config
+- Validate configuration
+- Provide configuration access to all components
+
+**Key Features:**
+- Environment variable support
+- Deep merge of configurations
+- Validation with helpful error messages
+- Sanitized config output (hides sensitive data)
+
+### 2. Logger Module (`ErrorLogger`)
+
+**Responsibilities:**
+- Log all events (errors, warnings, info)
+- Track error frequency
+- Rotate log files
+- Sanitize sensitive data
+
+**Key Features:**
+- Winston-based logging
+- Daily log rotation
+- Multiple output formats (JSON, text)
+- Console and file outputs
+- Error rate tracking
+- Automatic sensitive data redaction
+
+### 3. Notification Manager (`NotificationManager`)
+
+**Responsibilities:**
+- Coordinate all notification channels
+- Manage cooldown periods
+- Format messages for different channels
+
+**Supported Channels:**
+- Email (via Nodemailer)
+- Slack (via Webhooks)
+- SMS (planned - Twilio)
+
+**Alert Levels:**
+- Critical (🔴)
+- Warning (⚠️)
+- Info (ℹ️)
+- Recovery (✅)
+
+### 4. API Error Monitor (`ApiErrorMonitor`)
+
+**Responsibilities:**
+- Track API errors via middleware
+- Log request/response details
+- Monitor error rates
+- Detect slow requests
+- Handle 404s
+
+**Integration Points:**
+- Express error middleware
+- Request logger middleware
+- 404 handler
+- Async handler wrapper
+
+### 5. Server Health Monitor (`ServerHealthMonitor`)
+
+**Responsibilities:**
+- Periodic health checks
+- Custom health check registration
+- Uptime tracking
+- Graceful shutdown handling
+- Uncaught exception handling
+
+**Features:**
+- Customizable health checks
+- Health check endpoints
+- Consecutive failure tracking
+- Recovery notifications
+- Process signal handling
+
+### 6. System Resource Monitor (`SystemResourceMonitor`)
+
+**Responsibilities:**
+- Monitor CPU usage (process and system)
+- Monitor memory usage
+- Track metrics history
+- Alert on threshold breaches
+
+**Metrics Tracked:**
+- CPU percentage (process and system-wide)
+- Memory usage (heap, RSS, total)
+- System information
+- Historical data (last 60 readings)
+
+### 7. Database Connection Monitor (`DbConnectionMonitor`)
+
+**Responsibilities:**
+- Monitor database connections
+- Perform health checks
+- Track connection statistics
+- Alert on connection failures
+
+**Supported Databases:**
+- MongoDB (via Mongoose)
+- PostgreSQL
+- MySQL
+- Redis
+
+## Data Flow
+
+### 1. Error Tracking Flow
+
+```
+Request → Express App → Error Occurs
+                           │
+                           ▼
+                    Error Middleware
+                           │
+                           ├─→ Log Error (ErrorLogger)
+                           │
+                           ├─→ Check Error Rate
+                           │
+                           ├─→ Send Alert (if threshold exceeded)
+                           │
+                           └─→ Send Response to Client
+```
+
+### 2. Health Check Flow
+
+```
+Cron Schedule → Health Monitor
+                      │
+                      ├─→ Run Custom Checks
+                      │
+                      ├─→ Aggregate Results
+                      │
+                      ├─→ Compare with Previous Status
+                      │
+                      └─→ Send Alert (if status changed)
+```
+
+### 3. System Monitoring Flow
+
+```
+Cron Schedule → System Monitor
+                      │
+                      ├─→ Collect CPU Metrics
+                      │
+                      ├─→ Collect Memory Metrics
+                      │
+                      ├─→ Store in History
+                      │
+                      ├─→ Check Thresholds
+                      │
+                      └─→ Send Alert (if exceeded)
+```
+
+### 4. Notification Flow
+
+```
+Alert Triggered → Notification Manager
+                         │
+                         ├─→ Check Cooldown Period
+                         │
+                         ├─→ Format Message
+                         │
+                         ├─→ Send to Email
+                         │
+                         ├─→ Send to Slack
+                         │
+                         ├─→ Send to SMS
+                         │
+                         └─→ Log Result
+```
+
+## Design Patterns
+
+### 1. Singleton Pattern
+- `NodeMonitor` class is typically instantiated once per application
+
+### 2. Observer Pattern
+- Monitors observe application state and notify when thresholds are exceeded
+
+### 3. Strategy Pattern
+- Different notification strategies (Email, Slack, SMS)
+- Different database monitoring strategies
+
+### 4. Middleware Pattern
+- Express middleware for error tracking and request logging
+
+### 5. Factory Pattern
+- Creating different types of monitors based on configuration
+
+## Security Considerations
+
+### 1. Data Sanitization
+- Automatic redaction of sensitive fields
+- Configurable sensitive field list
+- Applied to all logs and notifications
+
+### 2. Credential Management
+- Environment variable support
+- No hardcoded credentials
+- Sanitized config output
+
+### 3. Rate Limiting
+- Cooldown periods prevent notification spam
+- Configurable per alert type
+
+### 4. Secure Communication
+- HTTPS for webhooks
+- TLS for email (STARTTLS)
+- Encrypted credential storage recommended
+
+## Scalability
+
+### 1. Horizontal Scaling
+- Each instance monitors independently
+- Centralized logging recommended (ELK, CloudWatch)
+- Shared notification channels
+
+### 2. Performance
+- Non-blocking operations
+- Scheduled checks (not continuous)
+- Configurable intervals
+- Minimal overhead
+
+### 3. Resource Usage
+- Low memory footprint
+- CPU usage < 1% typically
+- Configurable metric history size
+
+## Extension Points
+
+### 1. Custom Monitors
+```javascript
+class CustomMonitor {
+  constructor(config, logger, notificationManager) {
+    // Your implementation
+  }
+  
+  start() { /* ... */ }
+  stop() { /* ... */ }
+}
+```
+
+### 2. Custom Notifiers
+```javascript
+class CustomNotifier {
+  async send(alertType, subject, message, details) {
+    // Your implementation
+  }
+}
+```
+
+### 3. Custom Health Checks
+```javascript
+monitor.registerHealthCheck('custom', async () => {
+  // Your check logic
+  return true; // or false
+});
+```
+
+## Future Enhancements
+
+1. **Metrics Export**
+   - Prometheus format
+   - StatsD support
+   - Custom metrics API
+
+2. **Advanced Analytics**
+   - Trend analysis
+   - Anomaly detection
+   - Predictive alerts
+
+3. **Web Dashboard**
+   - Real-time metrics
+   - Historical charts
+   - Alert management
+
+4. **Distributed Tracing**
+   - Request correlation
+   - Microservices support
+   - OpenTelemetry integration
+
+5. **Advanced Notifications**
+   - PagerDuty integration
+   - Discord/Telegram support
+   - Custom webhooks
+   - Alert routing rules
+

package/node-monitor/CHANGELOG.md

@@ -0,0 +1,105 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2024-01-15
+
+### Added
+- Initial release of Node Monitor
+- API error tracking with Express middleware
+- Server health monitoring with customizable health checks
+- System resource monitoring (CPU, memory)
+- Database connection monitoring for MongoDB, PostgreSQL, MySQL, and Redis
+- Email notifications via Nodemailer
+- Slack notifications via webhooks
+- Advanced logging with Winston and daily rotation
+- Configurable thresholds and intervals
+- Environment variable support
+- Sensitive data sanitization
+- Graceful shutdown handling
+- Monitoring dashboard endpoints
+- Comprehensive documentation and examples
+- Example Express application
+- Setup guide for production deployment
+
+### Features
+- **Error Tracking**
+  - Automatic API error logging
+  - Error rate monitoring with alerts
+  - Stack trace capture
+  - Request context logging
+  - Slow request detection
+
+- **Health Monitoring**
+  - Customizable health checks
+  - Heartbeat mechanism
+  - Uptime tracking
+  - Graceful shutdown support
+  - Uncaught exception handling
+
+- **System Monitoring**
+  - CPU usage tracking (process and system)
+  - Memory usage monitoring
+  - Configurable alert thresholds
+  - Historical metrics tracking
+  - System information reporting
+
+- **Database Monitoring**
+  - Connection health checks
+  - Support for multiple database types
+  - Connection statistics
+  - Automatic reconnection detection
+  - Query timeout handling
+
+- **Notifications**
+  - Multi-channel support (Email, Slack)
+  - Alert level classification (Critical, Warning, Info, Recovery)
+  - Cooldown periods to prevent spam
+  - Rich formatting for emails and Slack
+  - Configurable recipients
+
+- **Logging**
+  - Winston-based logging
+  - Daily log rotation
+  - Multiple log levels
+  - JSON and text formats
+  - Console and file outputs
+  - Sensitive data sanitization
+
+### Security
+- Automatic sanitization of sensitive fields (passwords, tokens, API keys)
+- Environment variable support for credentials
+- Configurable sensitive field list
+- Secure SMTP and webhook communication
+
+### Documentation
+- Comprehensive README with examples
+- Complete setup guide
+- API reference
+- Configuration guide
+- Troubleshooting section
+- Example application
+
+## [Unreleased]
+
+### Planned Features
+- SMS notifications via Twilio
+- Discord/Telegram webhook support
+- PagerDuty integration
+- Prometheus metrics export
+- Grafana dashboard templates
+- Custom metric tracking
+- Performance profiling
+- Memory leak detection
+- Event loop lag monitoring
+- Request rate limiting monitoring
+- WebSocket connection monitoring
+- Microservices distributed tracing
+- Custom alert rules engine
+- Web-based dashboard UI
+- Historical data persistence
+- Metrics aggregation and analytics
+

package/node-monitor/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to Node Monitor
+
+Thank you for your interest in contributing to Node Monitor! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+Please be respectful and constructive in all interactions. We aim to maintain a welcoming and inclusive community.
+
+## How to Contribute
+
+### Reporting Bugs
+
+1. Check if the bug has already been reported in [Issues](https://github.com/yourorg/node-monitor/issues)
+2. If not, create a new issue with:
+   - Clear title and description
+   - Steps to reproduce
+   - Expected vs actual behavior
+   - Environment details (Node version, OS, etc.)
+   - Relevant logs or error messages
+
+### Suggesting Features
+
+1. Check existing issues and discussions
+2. Create a new issue with:
+   - Clear description of the feature
+   - Use cases and benefits
+   - Possible implementation approach
+   - Any potential drawbacks
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Write or update tests
+5. Update documentation
+6. Commit your changes (`git commit -m 'Add amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/yourorg/node-monitor.git
+cd node-monitor
+
+# Install dependencies
+npm install
+
+# Run example application
+npm run example
+```
+
+## Coding Standards
+
+- Use ES6+ features
+- Follow existing code style
+- Add JSDoc comments for public APIs
+- Keep functions focused and small
+- Use meaningful variable names
+- Handle errors appropriately
+
+## Testing
+
+```bash
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+## Documentation
+
+- Update README.md for user-facing changes
+- Update SETUP_GUIDE.md for configuration changes
+- Add JSDoc comments for new functions
+- Update CHANGELOG.md
+
+## Commit Messages
+
+Use clear and descriptive commit messages:
+
+```
+feat: Add SMS notification support
+fix: Resolve memory leak in metrics tracking
+docs: Update configuration examples
+refactor: Simplify error handling logic
+test: Add tests for database monitoring
+```
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+