cybercog / laravel-sense
Laravel Application Audit.
Fund package maintenance!
paypal.me/antonkomarev
Installs: 158
Dependents: 0
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 2
Open Issues: 12
Requires
- php: ^7.1.3
- illuminate/database: ^5.5|^6.0|^7.0|^8.0
- illuminate/support: ^5.5|^6.0|^7.0|^8.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: ^3.5|^4.0|^5.0|^6.0
- phpunit/phpunit: ^6.0|^7.0|^8.0|^9.0
README
Introduction
Beware! If you feel that your application starts to run slower, it can become a smelling zombie!
Laravel Sense provides a dashboard for application profiling. Sense allows you to easily monitor key metrics such as HTTP requests & Eloquent queries. Understand what is happening in black box system in a minutes!
DON'T USE IT ON PRODUCTION! PROFILING MAY SLOW DOWN YOUR APPLICATION ENORMOUSLY!
Requests list
Request details
Contents
- Features
- Requirements
- Installation
- Usage
- Changelog
- Contributing
- Testing
- Security
- Contributors
- Alternatives
- License
- About CyberCog
Features
- Can profile APIs
- Designed to work with Laravel Eloquent models
- Dashboard with profiling summaries
- Easy to use dashboard authentication
- Following PHP Standard Recommendations:
Requirements
Laravel Sense has a few requirements you should be aware of before installing:
- PHP 7.1.3+
- Composer
- Laravel Framework 5.5+
Installation
You can install the package via Composer.
$ composer require cybercog/laravel-sense --dev
The package will register itself automatically.
Perform Database Migration
At last you need to publish and run database migrations.
$ php artisan migrate
If you want to make changes in migrations, publish them to your application first.
$ php artisan vendor:publish --tag=sense-migrations
Usage
Dashboard Authentication
Sense exposes a dashboard at /sense. By default, you will only be able to access this dashboard in the local environment.
To define a more specific access policy for the dashboard, you should use the \Cog\Laravel\Sense\Authentication\Services\Authenticator::using method.
The using method accepts a callback which should return true or false, indicating whether the user should have access to the Sense dashboard.
Typically, you should call Authenticator::using in the boot method of your AuthServiceProvider:
\Cog\Laravel\Sense\Authentication\Services\Authenticator::using(function ($request) { // return true / false; });
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Testing
Run the tests with:
$ vendor/bin/phpunit
Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
Contributors
Laravel Sense contributors list
Alternatives
Feel free to add more alternatives as Pull Request.
License
Laravel Sensepackage is open-sourced software licensed under the MIT license by Anton Komarev.Smellingimage licensed under Creative Commons 3.0 by Gan Khoon Lay.
About CyberCog
CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.
