Activity Logging

Overview

Exowpee automatically tracks changes to important models through an activity logging system. Every create, update, and delete operation on tracked models is recorded with who made the change, what changed, and when.

How it works

AuditableTrait

File: packages/shared/src/Traits/AuditableTrait.php Add this trait to any model to automatically log its changes. AuditableTrait wraps Spatie’s LogsActivity trait internally and also provides a custom AuditableBuilder:

use Exowpee\Shared\Traits\AuditableTrait;

class Product extends Model
{
    use AuditableTrait;
}

The trait hooks into Eloquent’s model events via Spatie Activity Log:

Event	What’s logged
`created`	The new model and all its attributes
`updated`	The old values and new values (diff)
`deleted`	The model that was removed

ActivityLog model

File: packages/shared/src/Models/ActivityLog.php The shared_activity_log table stores all tracked changes:

Column	Type	Description
`id`	bigint (auto-incrementing)	Unique identifier
`company_id`	string (KSUID, nullable)	Scopes log to a company
`organization_id`	string (KSUID, nullable)	Scopes log to an organization
`log_name`	string	Category (e.g., “product”, “order”)
`description`	text	Human-readable description
`subject_type`	string	Model class that was changed
`subject_id`	string	ID of the changed model
`event`	string (nullable)	The event type (created, updated, deleted)
`causer_type`	string	Who made the change (UserProfile, Agent)
`causer_id`	string	ID of who made the change
`properties`	json	Old and new values
`batch_uuid`	uuid (nullable)	Groups related activity entries in the same batch
`created_at`	timestamp	When the change happened

Unlike most tables in Exowpee, shared_activity_log uses bigIncrements (auto-incrementing integer) as its primary key, not KSUID.

Querying activity logs

Via API

The ActivityLogController (packages/shared/src/Http/Controllers/ActivityLogController.php) exposes three endpoints:

`records` — Activity for a specific model instance

Requires permission: read_record_activity

Parameter	Type	Description
`subject`	string	The model type name
`id`	integer	The subject ID
`company_id`	integer	The company ID to scope to

Returns all activity log entries for the given subject, ordered by created_at descending.

`actions` — Activity caused by a specific user profile

Requires permission: read_user_activity

Parameter	Type	Description
`user_profile_id`	integer	The user profile ID
`company_id`	integer	The company ID to scope to

Returns activity entries grouped by batch_uuid, showing one entry per batch.

`getForBatch` — All activity entries in a batch

Parameter	Type	Description
`uuid`	string	The batch UUID
`company_id`	integer	The company ID to scope to

Returns all entries sharing the same batch_uuid, grouped by subject_type and subject_id. If there is only one entry, it is returned directly.

Via code

// Get all activities for a product
$product = Product::find($id);
$activities = ActivityLog::whereCompanyId($companyId)
    ->whereSubjectType(Product::class)
    ->whereSubjectId($product->id)
    ->orderBy('created_at', 'desc')
    ->get();

// Get all activities caused by a user profile
$activities = ActivityLog::whereCompanyId($companyId)
    ->whereCauserType(UserProfile::class)
    ->whereCauserId($userProfileId)
    ->orderBy('created_at', 'desc')
    ->get();

What’s logged

The properties column stores a JSON object with the changes:

{
  "old": {
    "title": "Samsung Galaxy A54",
    "price": 180000
  },
  "attributes": {
    "title": "Samsung Galaxy A54 5G",
    "price": 185000
  }
}

For created events, only attributes is present. For deleted events, only old is present.

Getting started

Architecture

Developer guide

Operations

More

Activity Logging

Overview

How it works

AuditableTrait

ActivityLog model

Querying activity logs

Via API

`records` — Activity for a specific model instance

`actions` — Activity caused by a specific user profile

`getForBatch` — All activity entries in a batch

Via code

What’s logged

​Overview

​How it works

​AuditableTrait

​ActivityLog model

​Querying activity logs

​Via API

​records — Activity for a specific model instance

​actions — Activity caused by a specific user profile

​getForBatch — All activity entries in a batch

​Via code

​What’s logged

Overview

How it works

AuditableTrait

ActivityLog model

Querying activity logs

Via API

`records` — Activity for a specific model instance

`actions` — Activity caused by a specific user profile

`getForBatch` — All activity entries in a batch

Via code

What’s logged