cybercog/laravel-sense

Laravel Application Audit.

0.5.2 2019-09-04 09:36 UTC

README

cog-laravel-sense

Releases Build Status StyleCI Code Quality License

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

requests-list

Request details

request-statements-index

Contents

Features

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

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.

CyberCog