# Interface AuditLoggerOptions

Constructor options for AuditLogger.

interface AuditLoggerOptions {
requiredAuthToken?: string;
retentionMs?: number;
sensitiveKeys?: readonly string[];
sinks?: AuditSink[];
}

- Defined in utils/auditSink.ts:106

##### Index

### Properties

requiredAuthToken?
retentionMs?
sensitiveKeys?
sinks?

## Properties

### `Optional` requiredAuthToken

requiredAuthToken?: string

Authorization token required to call `getLogs()`, `queryLogs()`, `clear()`, and `eraseByUser()`. When absent, those methods are unrestricted (suitable for testing).

- Defined in utils/auditSink.ts:119

### `Optional` retentionMs

retentionMs?: number

Maximum age of log entries in milliseconds (data retention enforcement)

- Defined in utils/auditSink.ts:113

### `Optional` sensitiveKeys

sensitiveKeys?: readonly string[]

Top-level parameter keys treated as PII and redacted to `'[REDACTED]'`. Defaults to DEFAULT_SENSITIVE_KEYS.

- Defined in utils/auditSink.ts:124

### `Optional` sinks

sinks?: AuditSink[]

Extra write-only sinks (e.g. `FileAuditSink`, `StructuredJsonSink`). Replaces the default `StderrAuditSink` when provided.

- Defined in utils/auditSink.ts:111