Skip to content
1 min read · 222 words

Type Alias: DispatchRunnerObservabilityHooks

ts
type DispatchRunnerObservabilityHooks = {
  dispatchEnd: [[DispatchEndEvent], []];
  dispatchStart: [[DispatchStartEvent], []];
  error: [[BaseException], []];
  iterationEnd: [[IterationEndEvent], []];
  iterationStart: [[IterationStartEvent], []];
  log: [[LogEvent], []];
  toolExecutionEnd: [[ToolExecutionEndEvent], []];
  toolExecutionStart: [[ToolExecutionStartEvent], []];
};

Defined in: lib/types/dispatch_runner.ts:363

Observability hook events on @nhtio/adk!DispatchRunner.

Remarks

Instrumentation-only events. Register handlers via the observers field of the dispatch input. Removing an observer does not affect dispatch correctness.

Properties

PropertyTypeDescriptionDefined in
dispatchEnd[[DispatchEndEvent], []]Fired once when the dispatch ends (ack / nack / aborted).lib/types/dispatch_runner.ts:375
dispatchStart[[DispatchStartEvent], []]Fired once when the dispatch begins.lib/types/dispatch_runner.ts:373
error[[BaseException], []]Fired when a non-fatal pipeline or executor error occurs. The exception is also re-thrown.lib/types/dispatch_runner.ts:377
iterationEnd[[IterationEndEvent], []]Fired at the end of each iteration.lib/types/dispatch_runner.ts:371
iterationStart[[IterationStartEvent], []]Fired at the start of each iteration.lib/types/dispatch_runner.ts:369
log[[LogEvent], []]Fired for every structured log event emitted by the executor via DispatchExecutorHelpers.log.lib/types/dispatch_runner.ts:379
toolExecutionEnd[[ToolExecutionEndEvent], []]Forwarded from the context after a tool handler returns or throws.lib/types/dispatch_runner.ts:367
toolExecutionStart[[ToolExecutionStartEvent], []]Forwarded from the context immediately before a tool handler is called.lib/types/dispatch_runner.ts:365