Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 2.78 KB

readme.md

File metadata and controls

49 lines (25 loc) · 2.78 KB

Eyewitness.io package for Laravel 5 applications

Eyewitness.io is a monitoring and application analytic service built specifically for Laravel. Never miss a silent failure, and be the first to know how your applications are actually performing. Monitor your queues, schedulers/cron, email, logs, security and every part of your application.

Installation

Composer

1) Add the package to "require" in composer.json

composer require eyewitness/eye

2) Once composer is finished, you need to add the service provider. Open config/app.php, and add a new item to the providers array.

Eyewitness\Eye\EyeServiceProvider::class,

3) Now run the package installer.

php artisan eyewitness:install

At the end you will be optionally asked for your email, so you we can email you a link to login with your app_token and secret_key (the email will be sent by our server, so it is ok if you do not have email configured on your local server).

Alternatively you can just copy and paste the app_token and secret_key yourself into the Eyewitness.io website.

4) Now log into https://eyewitness.io to view your server. If you dont already have an account, you can create a free trial. Once you login, simply use your app_token and secret_key to associate this application to your account.

Setup

Running php artisan eyewitness:install will actually setup almost everything for you. It will automatically start monitoring your default queue, know what cron jobs need to run, start emailing testing etc.

In the config/eyewitness.php file there are a number of options to disable certain checks (for example, if you dont use email or queues in your application).

The only config option some people need to change is queue_tube_list. If you run multiple queue tubes (using --tube) - then you should add the other queue tubes you want monitored here.

Version

This package current supports all Laravel versions >=5.1.

If you are running Lumen, Laravel 5.0 or Laravel 4.2 and would like to use Eyewitness.io on those applications - please get in contact with us [email protected] and we'll organise to get you beta access to those packages currently under development.

Security Vulnerabilites

If you discover a security vulnerability within this pacakge, please email [email protected] instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

License

This package is open-sourced software licensed under the MIT license.