https://github.com/coloredcow/laravel-audit

Audit Logs for Laravel applications
https://github.com/coloredcow/laravel-audit

audit audit-log composer-package laravel laravel-application listen

Last synced: 5 days ago
JSON representation

Audit Logs for Laravel applications

• Host: GitHub
• URL: https://github.com/coloredcow/laravel-audit
• Owner: ColoredCow
• License: gpl-3.0
• Created: 2017-09-01T09:56:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-10T06:41:20.000Z (28 days ago)
• Last Synced: 2024-12-10T07:41:07.925Z (28 days ago)
• Topics: audit, audit-log, composer-package, laravel, laravel-application, listen
• Language: PHP
• Homepage:
• Size: 37.1 KB
• Stars: 4
• Watchers: 4
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Audit Logs for Laravel

A package to capture system activity in a Laravel application. Currently supports the following fields:

- IP of HTTP request,

- HTTP referer,

- a description of the action you want to audit.

- user id

- Other details like data and keys

## Installation

1. Run `composer require coloredcow/laravel-audit`

2. Add the `ColoredCow\LaravelAudit\AuditServiceProvider` to `config/app.php`

```

'providers' => [

    ColoredCow\LaravelAudit\AuditServiceProvider::class

];

```

3. Run `php artisan migrate`

## Usage

1. Use the `ColoredCow\LaravelAudit\Events\Auditable` trait in the events you want to audit. And add this to the contructor of the event.

```

$this->setAudit([

    'ip' => 'ip-of-user-here',

    'referer' => 'referer-address',

    'action' => 'description of event and action being audited'

]);

```

2. Use the `ColoredCow\LaravelAudit\Listeners\AuditActivities` listener to listen to the events to want to audit. Map it in the EventServiceProvider of your laravel application.

## Audit Facade

1. Add AuditFacade in your app to make a audit directly from the applications.

```

 AuditFacade::make(['action' => 'Audit Action']);

```

2. You can also overide other properties like ip, userid and descriptions.

```

 AuditFacade::make(['action' => 'Audit Action', 'ip' => 'My IP']);

```