Interface: AuditTrailConfig ​

Defined in: packages/core/src/core/middleware/AuditTrail.ts:80

Configuration for the AuditTrail middleware.

Properties ​

actionField? ​

ts
readonly optional actionField: string;

Defined in: packages/core/src/core/middleware/AuditTrail.ts:100

Field name used as the action discriminator in tool arguments. Defaults to 'action'. Set to the correct discriminator for non-standard tools (e.g., 'command', 'operation').

Default ​

ts
'action'

extractIdentity()? ​

ts
readonly optional extractIdentity: (ctx) => AuditIdentity;

Defined in: packages/core/src/core/middleware/AuditTrail.ts:109

Extract identity information from the request context. Return fields relevant for your compliance requirements.

Parameters ​

ParameterTypeDescription
ctxunknownRequest context

Returns ​

AuditIdentity

Identity object for audit logging

hashArgs? ​

ts
readonly optional hashArgs: boolean;

Defined in: packages/core/src/core/middleware/AuditTrail.ts:117

Whether to hash the arguments (SHA-256). When true, args are hashed for change detection without storing PII.

Default ​

ts
true

logResult? ​

ts
readonly optional logResult: "status" | "none";

Defined in: packages/core/src/core/middleware/AuditTrail.ts:127

What level of result detail to log.

  • 'status' — Log only success/error status (recommended)
  • 'none' — Don't log result at all

Default ​

ts
'status'

sink ​

ts
readonly sink: AuditSink;

Defined in: packages/core/src/core/middleware/AuditTrail.ts:85

Sink function for audit events. Can be a TelemetrySink, a logging function, or any other consumer.

toolName? ​

ts
readonly optional toolName: string;

Defined in: packages/core/src/core/middleware/AuditTrail.ts:91

Tool name to include in audit events. Should match the tool's registered name (e.g., 'billing').