Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saeedvaziry/laravel-monitoring
Monitor your Laravel servers
https://github.com/saeedvaziry/laravel-monitoring
laravel laravel-framework monitoring
Last synced: 5 days ago
JSON representation
Monitor your Laravel servers
- Host: GitHub
- URL: https://github.com/saeedvaziry/laravel-monitoring
- Owner: saeedvaziry
- License: mit
- Created: 2022-01-05T18:34:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-10T08:12:39.000Z (over 1 year ago)
- Last Synced: 2024-12-14T23:30:48.434Z (12 days ago)
- Topics: laravel, laravel-framework, monitoring
- Language: PHP
- Homepage:
- Size: 1.33 MB
- Stars: 174
- Watchers: 3
- Forks: 33
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Monitoring
[](https://packagist.org/packages/saeedvaziry/laravel-monitoring)
Monitor your Laravel applications server with a beautiful dashboard and get notified if anything gets wrong!
## Supported OS
This package works only on Linux servers.
## Installation
**1)** Install the latest version from composer
For PHP >= 8.1
```shell
composer require saeedvaziry/laravel-monitoring
```
For PHP <= 8.0
```shell
composer require saeedvaziry/laravel-monitoring "1.4.2"
```
**2)** Publish vendors
```shell
php artisan monitoring:publish
```
**3)** Run migrations
```shell
php artisan migrate
```
**4)** Set up a cronjob to collect data
```shell
* * * * * cd /path-to-your-project && php artisan monitoring:record
```
**5)** Visit `/monitoring` to see the statistics.
## Configuration
You can find the configuration at `config/monitoring.php`.
| Key | Description |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `instance_name` | This is your current server's name, And the data will be collected under this name. |
| `routes` | You can change the URL prefix of the monitoring dashboard. Also, You can protect the route by applying middlewares to it. |
| `models` | If you want to customize the models, define yours and update this config. |
| `chart_colors` | Chart colors are customizable by this config. |
| `notifications` | Currently, we support `Slack` and `Email` channels for notifications. However, You can add your custom channels. To add a custom channel, Create a class and implement it by `SaeedVaziry\Monitoring\Channels\Channel` and then add the class to `channels` under the `notifications` item. |
## Multi-Server support
Sometimes your source code is deployed to multiple servers.
For example, You have multiple webservers with a load balancer and another server for your Backoffice.
In this case, you just need to set a unique name for `MONITORING_INSTANCE_NAME` environment variable on each server, Of course, assuming that you have one database in common with all the servers that you want to monitor.
The result will be similar to the Demo picture.
## Command
You can use `php artisan monitoring:record` command to collect the data manually.
## Facade
Add the bellow line to your `config/app.php` file, Under the `allias`:
```php
'aliases' => [
...
'Monitoring' => \SaeedVaziry\Monitoring\Facades\Monitoring::class
...
];
```
With this Facade you can access the server's resource usages.
Example usages:
```php
Monitoring::cpu()->usage(); // returns CPU usage
Monitoring::memory()->usage(); // returns Memory usage
Monitoring::disk()->usage(); // returns Disk usage
```
## Purge Records
Without purging, the `monitoring_records` table can accumulate records very quickly. To mitigate this, you should schedule the monitoring:purge Artisan command to run daily or any time you wish.
You can also, Set the `purge_before` configuration at `config/monitoring.php`.
```php
$schedule->command('monitoring:purge')->daily();
```
## Contributing
Please feel free to submit an issue or open a PR.
## Credits
* [Laravel](https://laravel.com/)
* [Vue.js](https://vuejs.org/)
* [Tailwindcss](https://tailwindcss.com/)
* [Fontawesome Icons](https://fontawesome.com/)
## License
Laravel Monitoring is open-sourced software and licensed under the MIT License (MIT).