README

A Laravel package for logging application events into a database table. This package provides an extensible model, a database migration, and helper methods for recording user and system actions in a structured and searchable format.

Features

• Action Logging: Easily log predefined or custom actions with optional metadata.
• User Relationships: Track the user performing the action (logged_in_user_id) and any user related to the action (related_to_user_id).
• Structured Data: Store additional data as JSON for enhanced flexibility.
• Predefined Actions: Common actions like login, logout, user creation, and more are included.

Installation

1. Require the package Run the following command: composer require MattYeend/Logging

2. Publish the log.php model Run php artisan vendor:publish --tag=logging-model

3. Run Migrations Run the migrations to create the logs table: php artisan migrate

Usage

Log an Action

Use the Log model to log actions. The predefined constants simplify common actions

use App\Models\Log;

// Log a user login event 
Log::log(Log::ACTION_LOGIN, ['ip' => request()->ip()], auth()->id());

Log Custom Actions

You can log actions not predefined in the package: Log::log(99, ['custom_key' => 'custom_value'], auth()->id(), $relatedUserId);

Model Relationships

Retrieve the user who performed the action or the user related to it:

$log = Log::find(1);

// Logged-in user 
$loggedInUser = $log->loggedInUser;

// Related user 
$relatedUser = $log->relatedToUser;

Predefined Actions

Customisation

Extend the Logger Model

Add additional functionality by extending the Log model in your application.

Troubleshooting

1. Migration Not Found Ensure the LoggerServiceProvider is loading migrations by verifying the path in: src/LoggerServiceProvider.php: $this->loadMigrationsFrom(__DIR__ . '/Database/Migrations');

2. Data Validation Issues Ensure data passed to Log::log() is either null or an array. Example: Log::log(Log::ACTION_LOGIN, ['key' => 'value'], auth()->id());

Testing

To run tests, follow the next steps:

1. Install dependencies:

composer install

1. Run the tests:

composer test

License

This package is licensed under the MIT License.

Contributing

Feel free to fork the repository and submit pull requests for improvements or new features!