Skip to main content

Interface: AuditRelayOptions

Defined in: packages/audit-client/src/relay.ts:29

Options for an AuditRelay.

Properties​

ackTimeoutMs?​

readonly optional ackTimeoutMs?: number

Defined in: packages/audit-client/src/relay.ts:47

How long to wait for the stream's acknowledgement. Default 5000.

batchSize?​

readonly optional batchSize?: number

Defined in: packages/audit-client/src/relay.ts:39

Rows per transaction. Default 50.

clock?​

readonly optional clock?: Clock

Defined in: packages/audit-client/src/relay.ts:51

Defaults to the system clock.

db​

readonly db: Database<AuditOutboxTables>

Defined in: packages/audit-client/src/relay.ts:31

The module's pool, opened as that module's own role. One relay drains one outbox.

hosting?​

readonly optional hosting?: HostingInput

Defined in: packages/audit-client/src/relay.ts:49

The permission table; defaults to the real estate.

logger?​

readonly optional logger?: MessagingLogger

Defined in: packages/audit-client/src/relay.ts:37

Defaults to a silent logger.

maxBackoffMs?​

readonly optional maxBackoffMs?: number

Defined in: packages/audit-client/src/relay.ts:43

The longest wait after consecutive failures, in milliseconds. Default 30000.

module​

readonly module: string

Defined in: packages/audit-client/src/relay.ts:35

The module whose outbox this is; written into every record as producerModule.

pollIntervalMs?​

readonly optional pollIntervalMs?: number

Defined in: packages/audit-client/src/relay.ts:41

Wait between polls when the outbox is empty, in milliseconds. Default 500.

retainPublishedMs?​

readonly optional retainPublishedMs?: number

Defined in: packages/audit-client/src/relay.ts:45

How long published rows are kept, in milliseconds. Default 24 hours.

wire​

readonly wire: BrokerWire

Defined in: packages/audit-client/src/relay.ts:33

A connection as the module's own principal, which the permission table lets publish the audit event.