Quickstart

Install the package

Pull the module into your Go project. The library has zero non-stdlib dependencies for the core, ORM adapters are opt-in.

Initialize the auditor

Wire up an Auditor with your *sql.DB and a UserFunc that resolves the actor for each transaction.

import "github.com/gopackx/go-audit"

auditor, err := audit.New(sqlDB, audit.Config{
    Dialect:  audit.SQLite,
    UserFunc: func(ctx context.Context) (string, string) {
        return ctx.Value("user_id").(string), "user"
    },
})

Run migrations

Create the audit_log and audit_snapshots tables. Safe to call on every boot — it is idempotent.

Plug into GORM

Register the GORM plugin once on your *gorm.DB. From there, every Create/Update/Delete is recorded automatically.

Verify it works

Quick sanity check that everything is wired up end-to-end.

1. 1
   Create or update a record through GORM inside a request handler.
2. 2
   Query auditor.History(ctx, "users", id) and confirm a row is returned.
3. 3
   Inspect the diff JSON column — you should see before/after values for each changed field.