README

Server monitoring package for MoonShine admin panel.

Description

Moonshine Monitoring is a Laravel package that provides system resource monitoring capabilities for applications using the MoonShine admin panel. It tracks CPU, memory, and disk usage of your server and displays this information in an intuitive dashboard within MoonShine.

Features

Real-time monitoring of CPU usage
Memory consumption tracking
Disk space monitoring
Data visualization in MoonShine dashboard
Command-line interface for manual data recording
Database storage of monitoring records
Automatic data purging based on configuration
Multi-instance support with instance naming
Pure PHP implementation (no shell scripts required)
Enhanced dashboard with progress bars and real-time updates
Multi-language support (English and Russian)

Installation

Install the package via composer:

composer require zhandos717/moonshine-monitoring

Publish the configuration file:

php artisan vendor:publish --provider="Zhandos717\MoonshineMonitoring\MonitoringServiceProvider" --tag=config

Run the migrations:
```
php artisan migrate
```
The monitoring dashboard will automatically appear in your MoonShine menu.

Usage

Basic Usage

The package automatically adds a monitoring page to your MoonShine dashboard. You can configure whether this menu item is automatically added via the auto_menu option in the configuration file.

Command Line

You can manually record resource usage via the command line:

php artisan moonshine-monitoring:record

Scheduling

To continuously monitor your system, schedule the record command in your app/Console/Kernel.php:

protected function schedule(Schedule $schedule)
{
    $schedule->command('moonshine-monitoring:record')->everyMinute();
}

Configuration

After publishing the configuration file, you can modify the settings in config/monitoring.php:

auto_menu: Whether to automatically add the monitoring page to the MoonShine menu
instance_name: The name of this monitoring instance (defaults to your app name)
notifications: Telegram notification settings (not yet implemented)
migrations: Enable or disable package migrations
purge_before: Automatically purge records older than this time period

Dashboard Features

The updated monitoring dashboard includes:

Real-time Resource Monitoring
- Visual progress bars for CPU, memory, and disk usage
- Current usage percentage display
- Auto-refresh functionality for real-time updates
Historical Data Visualization
- Detailed table of historical monitoring records
- Time-based sorting of records
- Instance name identification
User Interface Enhancements
- Multi-language support (English/Russian)
- Responsive design for different screen sizes
- Intuitive controls for data refresh

Roadmap

Short-term Goals (v1.x)

Complete Dashboard Implementation
- Add line charts for historical data visualization
- Implement filtering by time periods
- Add instance comparison capabilities
Notification System
- Implement Telegram notifications for resource threshold breaches
- Add email notification support
- Create configurable alert thresholds
Performance Improvements
- Optimize database queries for large datasets
- Implement data aggregation for long-term storage
- Add caching mechanisms for frequently accessed data
UI/UX Enhancements
- Improve the visual design of metrics display
- Add dark mode support
- Implement responsive design for mobile devices

Long-term Goals (v2.x)

Extended Monitoring Capabilities
- Network usage monitoring
- Process monitoring
- Service status monitoring
- Database performance metrics
Advanced Analytics
- Predictive resource usage analysis
- Anomaly detection algorithms
- Usage pattern recognition
Multi-server Support
- Centralized monitoring dashboard
- Cross-server comparisons
- Distributed monitoring agents
Export and Reporting
- PDF report generation
- CSV data export
- Scheduled report delivery

MoonShine 3.x Compatibility

This package now fully supports MoonShine 3.x with the following updates:

Updated service provider for new MoonShine architecture
Compatible page and component implementations
Updated controller with proper JSON responses
Fixed debug code issues
Enhanced dashboard with historical data charts
Improved user interface with real-time updates

Issues and Improvements Needed

After analyzing the codebase and updating for MoonShine 3.x compatibility, here are the key technical issues and improvements needed:

Resolved Issues

Debug Code in Controllers
- Removed dd() statements from MonitoringController and MonitoringComponent
Incomplete Implementation
- Enhanced controller to return proper JSON responses
- Improved monitoring dashboard with historical data visualization
Migration Registration
- Fixed migration registration in service provider
- Added proper resource publishing configuration

Remaining Issues

Configuration Issues
- The notifications section in the config file is not implemented but has a placeholder
- The purge functionality for old records is configured but not implemented
Platform Support
- Shell scripts only exist for Darwin (macOS) and Linux, with no Windows support
- The script resolution logic may not work correctly on all systems
Code Quality
- Missing input validation in several components
- Limited error handling in shell script execution
- No unit tests exist for the package

Enhancement Opportunities

Data Visualization
- Add more detailed historical data charts
- Implement time range filtering for metrics
- Add comparison capabilities between different time periods
Performance Optimization
- Implement caching for frequently accessed data
- Add batch processing for recording multiple metrics
- Optimize database queries for large datasets
User Experience
- Add customizable alert thresholds
- Implement dashboard widgets that can be rearranged
- Add export functionality for monitoring data

Testing

The package includes comprehensive tests for all components:

# Run all tests
composer test

# Run tests with coverage
composer test-coverage

Test Coverage

Unit tests for all models, actions, and system resources
Feature tests for controllers and pages
Configuration tests
Shell script path validation

Running Tests

Install development dependencies:

composer install

Run the test suite:

./vendor/bin/phpunit

Test Structure

The tests are organized as follows:

tests/Unit/ - Unit tests for individual components
tests/Feature/ - Feature tests for integrated functionality
tests/TestCase.php - Base test case with package configuration

Current Test Status

Currently, we have implemented:

Simple unit tests that don't require the full Laravel/MoonShine environment
Tests for system resources (CPU, Memory, Disk)
Tests for the MonitoringRecord model
Basic configuration tests

Some tests that require the full MoonShine environment are currently failing due to dependency injection issues. These will be resolved in future updates.

Contributing

Contributions are welcome! Here's how you can help:

Fork the repository
Create a new branch for your feature or bug fix
Write your code and tests
Submit a pull request with a clear description of your changes

Development Guidelines

Follow PSR-12 coding standards
Write meaningful commit messages
Include tests for new functionality
Update documentation when needed
Ensure all tests pass before submitting a pull request

Areas Needing Contribution

Windows Support
- Create PowerShell scripts for Windows systems
- Test cross-platform compatibility
Additional Metrics
- Network usage monitoring
- Process monitoring
- Custom metric support
Testing
- Expand test coverage
- Add integration tests
- Set up continuous integration
Documentation
- Expand usage examples
- Add troubleshooting guides
- Create API documentation

Requirements

PHP 8.2 or higher
Laravel 10.0 or higher
MoonShine 3.0 or higher

License

The MIT License (MIT). Please see License File for more information.

zhandos717 / moonshine-monitoring

Maintainers

Details