Manual Logging

Use AuditService.log() for business events that are not automatically tracked by the Prisma extension.

Basic Usage

await auditService.log({
  action: 'invoice.approved',
  targetId: 'inv-123',
  targetType: 'Invoice',
  metadata: { amount: 5000, currency: 'USD' },
});

With Transaction

await prisma.base.$transaction(async (tx) => {
  await tx.invoice.update({ where: { id }, data: { status: 'approved' } });
  await auditService.log({ action: 'invoice.approved', targetId: id }, tx);
  // Both roll back together if anything fails
});

AuditLogModule.forRoot / forRootAsync Options

Option	Type	Default	Description
prisma	PrismaClient	required	Base Prisma client for audit storage
actorExtractor	(req) => AuditActor | Promise<AuditActor>	required	Extracts actor from HTTP request
tenantRequired	boolean	false	When true, log() and ambient query()/getById() require tenant context unless tenantId or allTenants is explicit
excludeRoutes	RouteInfo[]	[]	Routes excluded from AuditActorMiddleware
registerGlobalInterceptor	boolean	true	Set false to bind AuditInterceptor manually
correlationIdHeader	string	x-request-id	Header copied into metadata.correlationId
correlationIdGetter	(req) => string | undefined	—	Custom correlation ID source
tableName	string	audit_logs	Audit table name used by module-side log/query/prune APIs
tenantResolver	() => string | null	—	Custom tenant lookup before the optional @nestarc/tenancy fallback

Reason Metadata

Use @AuditReason() when a handler needs to attach a human-readable reason to entries emitted during the request:

@Patch(':id/role')
@AuditAction('user.role.changed')
@AuditReason('admin role update')
async updateRole() {
  // automatic tracking and manual logs can read the request audit reason
}