PHPackages                             souravmsh/audit-trail - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. souravmsh/audit-trail

ActiveLibrary[Logging & Monitoring](/categories/logging)

souravmsh/audit-trail
=====================

AuditTrail a Laravel package for managing audit logs

1.2.0(2mo ago)022MITPHPPHP ^8.2

Since Feb 2Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/souravmsh/audit-trail)[ Packagist](https://packagist.org/packages/souravmsh/audit-trail)[ Docs](https://github.com/souravmsh/audit-trail)[ RSS](/packages/souravmsh-audit-trail/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (10)Versions (4)Used By (0)

AuditTrail a Laravel package for managing audit logs
====================================================

[](#audittrail-a-laravel-package-for-managing-audit-logs)

[![Latest Version on Packagist](https://camo.githubusercontent.com/b0c985b8ce3507869292016eb5784eda0ffc7d0fa6ea8e3808384e0581904dcc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f736f757261766d73682f61756469742d747261696c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/souravmsh/audit-trail)[![GitHub Tests Action Status](https://camo.githubusercontent.com/4d733b2486d1b997c6a418e347c31200d20308a44f079399bfb8ded7a5bfadfd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f736f757261766d73682f61756469742d747261696c2f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/souravmsh/audit-trail/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/539bad10c84ab4571f1584b01fb5e228f2e3a057eb42559dd303a88b94c7bb71/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f736f757261766d73682f61756469742d747261696c2f6669782d7068702d636f64652d7374796c652d6973737565732e796d6c3f6272616e63683d6d61696e266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/souravmsh/audit-trail/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/521d03cf59b8e3bef046a2a45d8b0f45f9c7d5a009649149cad6b1cc7f8cc842/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f736f757261766d73682f61756469742d747261696c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/souravmsh/audit-trail)[![lICENSE](https://camo.githubusercontent.com/1c95b850fa2450ce31fc8a3ab73a671c73459f2cc4c629f57639e0c2991ae374/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f736f757261766d73682f61756469742d747261696c)](https://github.com/souravmsh/audit-trail/blob/master/LICENSE.MD)

---

**Audit Trail** is a Laravel package that provides an easy-to-use mechanism for maintaining table row audit logs. It automatically tracks changes to database records, including created, updated, and deleted events, making it easier to monitor data modifications and user activities.

[![Preview](public/preview.png)](public/preview.png)

Installation
------------

[](#installation)

#### 1. You can install the package via Composer:

[](#1-you-can-install-the-package-via-composer)

```
composer require souravmsh/audit-trail
```

#### 2. Alternatively, you can install it manually:

[](#2-alternatively-you-can-install-it-manually)

Create directories:

```
mkdir -p packages/souravmsh
cd packages/souravmsh
```

Clone git repository:

```
git clone https://github.com/souravmsh/audit-trail.git
```

Add below lines to laravel/composer.json file:

```
"repositories": [
    {
        "type": "path",
        "url": "./packages/souravmsh/audit-trail",
        "options": {
            "symlink": true
        }
    }
]
```

Then,

```
composer require souravmsh/audit-trail:dev-main
```

#### 3. Publish and Run Migrations

[](#3-publish-and-run-migrations)

To publish and run the migrations, use:

```
php artisan audit-trail:install
```

This will create the necessary database tables for logging audit records.

Usage
-----

[](#usage)

### 1. Enable Audit Logging in .env (default true)

[](#1-enable-audit-logging-in-env-default-true)

`AUDITTRAIL_ENABLED=true/false`

### 2. Using AuditTrail Trait in a Model to Enable Audit Logging

[](#2-using-audittrail-trait-in-a-model-to-enable-audit-logging)

To enable auditing in a model, open your model file (e.g., User.php) and add the AuditTrail trait.

```