Class LogAuditStorage

Logs audit records through an ILogger. When constructed without a logger and used as a storage backend, queries return empty arrays.

At register time (LogAuditStorage construction with storage: 'log'), if no logger is available, throw the documented error.

Implements

IAuditStorage

Index

Constructors

Methods

append close isHealthy isReady query setContextLogger setLogLevel

Constructors

constructor

new LogAuditStorage(
options?: { level?: LogLevel; logger?: ILogger },
): LogAuditStorage
Parameters
- Optionaloptions: { level?: LogLevel; logger?: ILogger }
  - Optionallevel?: LogLevel
    
    Logger method to emit at; defaults to 'info'
  - Optionallogger?: ILogger
    
    Injectable ILogger (overrides context logger)
Returns LogAuditStorage
- Defined in packages/audit-plugin/src/storage/log-audit.ts:26

Methods

append

append(entry: StoredAuditEntry): Promise<void>
Routes the frozen record to logger[level]('audit', record).
Parameters
- entry: StoredAuditEntry
Returns Promise<void>
Implementation of IAuditStorage.append
- Defined in packages/audit-plugin/src/storage/log-audit.ts:42

close

close(): Promise<void>
The logger owns its own flush lifecycle; nothing to drain here.

Returns Promise<void>
Implementation of IAuditStorage.close
- Defined in packages/audit-plugin/src/storage/log-audit.ts:77

isHealthy

isHealthy(): Promise<boolean>
Lifecycle truth: the sink is the resolved ILogger, which is in-process, so reachability IS readiness. Where that logger's own transport goes is the logger's health to report, not this backend's.

Returns Promise<boolean>
true when a logger is configured

Since
0.6.0
Implementation of IAuditStorage.isHealthy
- Defined in packages/audit-plugin/src/storage/log-audit.ts:67

isReady

isReady(): boolean
Ready as long as a logger is configured.

Returns boolean
Implementation of IAuditStorage.isReady
- Defined in packages/audit-plugin/src/storage/log-audit.ts:72

query

query(_criteria?: AuditQuery): Promise<StoredAuditEntry[]>
The log sink is the durable trail; read-back happens through the logging backend, not this object. Returns [].
Parameters
- Optional_criteria: AuditQuery
Returns Promise<StoredAuditEntry[]>
Implementation of IAuditStorage.query
- Defined in packages/audit-plugin/src/storage/log-audit.ts:55

setContextLogger

setContextLogger(logger: ILogger): void
Initializes the logger from context when not injected.
Parameters
- logger: ILogger
Returns void
- Defined in packages/audit-plugin/src/storage/log-audit.ts:32

setLogLevel

setLogLevel(level: LogLevel): void
Sets the log level for emitting audit records.
Parameters
- level: LogLevel
Returns void
- Defined in packages/audit-plugin/src/storage/log-audit.ts:37