Zum Inhalt springen
Deutsch

DiagnosticsOptionsType

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

DiagnosticsOptionsType = object

Defined in: src/diagnostics/DiagnosticsOptions.ts:108

Plain options-object shape behind actor-ts.diagnostics.* — what the framework says about itself, as opposed to what it does.

Deliberately a separate family from DeadLetterQueueOptions, and the split is by reader: everything there is read by DeadLetterQueue and decides what is retained; everything here is read on the publish side by DeadLetterRef and decides how loudly a letter is announced (ConfigKeys.deadLetters carries the long form of that argument). Folding them together would make a suppression knob look like it gates capture, which the code deliberately prevents by capturing before it logs.

readonly optional debugEventStream?: boolean

Defined in: src/diagnostics/DiagnosticsOptions.ts:154

Trace event-stream subscribe and unsubscribe — actor-ts.diagnostics.debug.event-stream. Never publish.


readonly optional debugLifecycle?: boolean

Defined in: src/diagnostics/DiagnosticsOptions.ts:149

Trace actor lifecycle transitions — start, stop, restart — actor-ts.diagnostics.debug.lifecycle.


readonly optional debugUnhandled?: boolean

Defined in: src/diagnostics/DiagnosticsOptions.ts:144

Trace every message an actor was handed and declined. The HOCON leaf is actor-ts.diagnostics.debug.unhandled.


readonly optional logConfigOnStart?: boolean

Defined in: src/diagnostics/DiagnosticsOptions.ts:139

Write the merged configuration to the log once, at startup, with the layer each value came from and secret-looking keys withheld.

Emitted at info, unlike the three debug* switches below — an operator who asks for the dump has asked for output, and burying it at a level they would also have to raise makes the switch look broken.


readonly optional logDeadLetters?: number

Defined in: src/diagnostics/DiagnosticsOptions.ts:119

Dead letters logged in full before logging suspends. 0 turns dead-letter logging off entirely.

A count rather than the count | on | off union the issue sketched: a union-typed leaf has no clean Config getter, and “0 disables” is the convention retention, weakly-up-after and max-tombstones already use. “On, unthrottled” is logDeadLettersSuspendDurationMs = 0, not a third value here.


readonly optional logDeadLettersDuringShutdown?: boolean

Defined in: src/diagnostics/DiagnosticsOptions.ts:125

Log the burst terminate() produces while it drains mailboxes to dead letters. Off by default — see DEFAULT_LOG_DEAD_LETTERS_DURING_SHUTDOWN.


readonly optional logDeadLettersSuspendDurationMs?: number

Defined in: src/diagnostics/DiagnosticsOptions.ts:130

How long dead-letter logging stays suspended after the count above is reached. 0 never suspends, which is how “log every letter” is spelled.