README

Application activity logging for Laravel using MongoDB.

Requirements

• PHP 8.4+
• Laravel 12+
• mongodb/laravel-mongodb (official MongoDB Laravel integration)
• PHP mongodb extension (pecl install mongodb)

Upgrading from jenssegers/mongodb

This package previously depended on the abandoned jenssegers/mongodb package. It now uses the officially maintained mongodb/laravel-mongodb package.

In your Laravel application:

1. Remove the old package and install the official one:

composer remove jenssegers/mongodb
composer require mongodb/laravel-mongodb

1. Update your MongoDB model imports from:

use Jenssegers\Mongodb\Eloquent\Model;

to:

use MongoDB\Laravel\Eloquent\Model;

1. Update config/database.php if needed. The service provider is auto-discovered as MongoDB\Laravel\MongoDBServiceProvider.

2. Upgrade this package to the latest version:

composer require rajtika/mongovity

No changes are required to your mongovity usage (ActivityTrait, Mongovity service, or facade). Existing activity log data remains compatible.

Installation

composer require rajtika/mongovity
php artisan vendor:publish --tag=mongovity-config

Implementation

• Set your MongoDB connection and connection name in the mongovity.php config file.
• If you want to log all model activity automatically, follow the instructions below.

// Add ActivityTrait to the model you want to log
use Rajtika\Mongovity\Contracts\ActivityTrait;

// Log only specific attributes
protected static $logAttributes = ['name', 'email', 'status'];

// Or log fillable / all non-guarded attributes (for $guarded-only models)
protected static $logFillable = true;

// Skip logging when nothing changed on update
protected static $logOnlyDirty = true;

// Custom log message per event
public function getDescriptionForEvent(string $eventName): string
{
    return "MyModel {$eventName}";
}

// You can define specific events to be logged
protected $recordEvents = [
    'created',
    'updated',
    'deleted',
    'restored'
];
/** -----------OR--------- **/
protected $loggableEvents = [
    'created',
    'updated',
    'deleted',
    'restored'
];

// If you want to save a custom activity log
use Rajtika\Mongovity\Services\Mongovity;

app(Mongovity::class)
    ->by(Auth::user()) // Required *
    ->on(TestModel::find(1)) // optional
    ->event('created') // optional
    ->log('Your custom message');

/** OR **/
use Rajtika\Mongovity\Facades\Mongovity;

Mongovity::by(User::first())->log('Custom message');

If your user table has first_name and last_name, add this accessor to log the user name:

public function getNameAttribute()
{
    return $this->first_name . ' ' . $this->last_name;
}

If your user table uses a column other than mobile, add this accessor:

public function getMobileAttribute()
{
    return $this->mobile_number;
}

To access the built-in activity log UI, assign the admin role or the activity_logs permission to the user (when using Spatie Laravel Permission).

Notes

• Activity logging requires an authenticated user (Auth::check()).
• Use Eloquent save() / instance update() on a model. Mass updates such as Model::where()->update() do not fire model events and will not be logged.

Configuration

Avoid jQuery / DataTables conflicts

By default, the log page renders as a standalone HTML page with its own CDN assets. That can break your application dropdowns and plugins when the page is opened inside your app.

Set your application layout in config/mongovity.php:

'layout' => 'layouts.app',
'content_section' => 'content',
'styles_stack' => 'styles',
'scripts_stack' => 'scripts',

Your layout must already load:

• jQuery
• Bootstrap (v4 or v5)
• DataTables
• Moment.js and DateRangePicker (or leave skip_daterangepicker_assets as false)

Example in your layout:

@stack('styles')
...
@yield('content')
...
@stack('scripts')

Publish and customize the view if your stack names differ:

php artisan vendor:publish --tag=mongovity-views