developers-studio/logs

By using this package you can maintain your project activity, exception and request logs"

dev-main 2022-04-10 20:34 UTC

MIT

• Muhammad Latif

README

This package will helps you to main your project exception, activity and request logs.

Prerequisites

php 8.0 =< laravel 7 =<

Installation

Use the composer package manager to install this package.

composer require developers-studio/logs

Register Service Provider

// config/app.php
'providers' => [
    ...
    Ds\Logs\LogsServiceProvider::class
]

If you are using laravel 7 or 8 then you have no need to add middleware in app/Http/Kernal.php or if you are using laravel 9 then you have to add it.

// app/Http/Kernal.php
'api' => [
     ...
     \Ds\Logs\Http\Middleware\RequestLog::class
],

Run migrations

php artisan migrate

Usage

Request Logs

It will automatically store request and response. For listing of request logs use the following command.

// Call the package model
// use Ds\Logs\Models\ApiRequestLog;
 ApiRequestLog::all(); or ApiRequestLog::paginate();

Activity Logs

For storing activity log

public function FuncationName() {
 LogActivity::info('Activity Subject will be here!');
}

For listing activity logs

// Call package model (ActivityLog)
// use Ds\Logs\Models\ActivityLog;
ActivityLog::all(); or ActivityLog::paginate();

Exception Logs

For storing exception logs

// import class LogException
// use Ds\Logs\Helpers\LogException;
public function FunctionName(){
  try {
     ...
     ...
  } catch (\Exception $e) {
    return LogException::store(__METHOD__, $e, __FUNCTION__);
  }
}

For listing of exception logs

// import class ExceptionLogs
// use Ds\Logs\Models\ExceptionLogs;
ExceptionLogs::all(); or ExceptionLogs::paginate();

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT