https://github.com/cybercog/laravel-sense
Application profiling. That makes sense.
https://github.com/cybercog/laravel-sense
audit cog collectors debugging eloquent laravel metrics profiling sense sensor smell-detector
Last synced: 2 months ago
JSON representation
Application profiling. That makes sense.
- Host: GitHub
- URL: https://github.com/cybercog/laravel-sense
- Owner: cybercog
- License: mit
- Created: 2018-09-25T14:32:13.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-13T21:38:56.000Z (about 5 years ago)
- Last Synced: 2024-11-17T10:10:43.811Z (11 months ago)
- Topics: audit, cog, collectors, debugging, eloquent, laravel, metrics, profiling, sense, sensor, smell-detector
- Language: PHP
- Homepage: https://komarev.com/sources/laravel-sense
- Size: 66.4 KB
- Stars: 14
- Watchers: 4
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laravel Sense
## 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](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Testing](#testing)
- [Security](#security)
- [Contributors](#contributors)
- [Alternatives](#alternatives)
- [License](#license)
- [About CyberCog](#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:
- [PSR-1 (Basic Coding Standard)](http://www.php-fig.org/psr/psr-1/)
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/)
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/)
## 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.
```shell script
$ 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.
```shell script
$ php artisan migrate
```
If you want to make changes in migrations, publish them to your application first.
```shell script
$ 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`:
```php
\Cog\Laravel\Sense\Authentication\Services\Authenticator::using(function ($request) {
// return true / false;
});
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Testing
Run the tests with:
```shell script
$ vendor/bin/phpunit
```
## Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
## Contributors
| 
Anton Komarev |
| :---: |
[Laravel Sense contributors list](../../contributors)
## Alternatives
- [barryvdh/laravel-debugbar](https://github.com/barryvdh/laravel-debugbar)
- [itsgoingd/clockwork](https://github.com/itsgoingd/clockwork)
- [jkocik/laravel-profiler](https://github.com/jkocik/laravel-profiler)
*Feel free to add more alternatives as Pull Request.*
## License
- `Laravel Sense` package is open-sourced software licensed under the [MIT license](LICENSE) by [Anton Komarev].
- `Smelling` image licensed under [Creative Commons 3.0](https://creativecommons.org/licenses/by/3.0/us/) by Gan Khoon Lay.
## About CyberCog
[CyberCog](https://cybercog.su) is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.
- [Follow us on Twitter](https://twitter.com/cybercog)
- [Read our articles on Medium](https://medium.com/cybercog)
[Anton Komarev]: https://komarev.com