AuditRecord
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:41
A single audit-trail entry for one pipeline operation (who did what, when, and with what outcome), forwarded to an AuditSink.
Unlike a dead letter (failures only), an audit record is written for both successful and failed operations, so denied/rejected attempts are captured too.
Properties
Section titled “Properties”action
Section titled “action”action:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:49
Logical action name, e.g. user.create. Defaults to the request name.
actor?
Section titled “actor?”
optionalactor?:AuditActor
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:55
The principal that performed the action, if resolvable.
correlationId
Section titled “correlationId”correlationId:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:45
Correlation ID of the pipeline run (for cross-system tracing).
durationMs
Section titled “durationMs”durationMs:
number
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:69
Wall-clock duration of the operation in milliseconds.
error?
Section titled “error?”
optionalerror?:AuditError
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:67
Error details — present only when outcome is 'failure'.
handlerName
Section titled “handlerName”handlerName:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:61
Handler class name, e.g. CreateUserHandler.
id:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:43
Unique id for this entry (UUIDv7, so ids sort in start order).
metadata?
Section titled “metadata?”
optionalmetadata?:Record<string,unknown>
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:73
Metadata from the metadata factory, plus tenantId when present.
outcome
Section titled “outcome”outcome:
AuditOutcome
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:53
Whether the operation succeeded or failed.
payload?
Section titled “payload?”
optionalpayload?:unknown
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:63
The request payload (redacted), unless captureRequest: false.
requestKind
Section titled “requestKind”requestKind:
AuditRequestKind
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:57
Whether the request was a command, query, event, or unknown.
requestName
Section titled “requestName”requestName:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:59
Request class name, e.g. CreateUserCommand.
response?
Section titled “response?”
optionalresponse?:unknown
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:65
The handler response (redacted), only when captureResponse: true.
severity
Section titled “severity”severity:
AuditSeverity
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:51
Severity of the action. Defaults to 'medium' ('low' for queries).
tenantId?
Section titled “tenantId?”
optionaltenantId?:string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:47
Active tenant identifier if execution occurred within a multi-tenant context.
timestamp
Section titled “timestamp”timestamp:
string
Defined in: pipeline-audit/src/interfaces/audit-record.interface.ts:71
ISO-8601 timestamp of when the operation started.