Class BaseTraceProviderAbstract

constructor

• new BaseTraceProvider(
      options: { description: string; displayName: string; id: string },
  ): BaseTraceProvider

  Parameters

  • options: { description: string; displayName: string; id: string }

  Returns BaseTraceProvider

Optional Readonlydescription

Optional ReadonlydisplayName

Readonlyid

failTrace

• failTrace(traceId: string, errorMessage: string): Promise<void>

  Finalizes a trace as error when execution fails before any span is produced (e.g. a bad model id throws before onStart).

  Parameters

  • traceId: string
  • errorMessage: string

  Returns Promise<void>

AbstractgetAllTraces

• getAllTraces(): Promise<TraceSummary[]>

  Returns compact summaries for every trace known to this provider, newest first. Used to populate the Traces sidebar.

  Returns Promise<TraceSummary[]>

getTrace

• getTrace(traceId: string): Promise<TraceWithSpans | undefined>

  Returns the trace with the given ID together with all of its spans, or undefined when the trace is unknown.

  Parameters

  • traceId: string

  Returns Promise<TraceWithSpans | undefined>

AbstracthasTrace

• hasTrace(traceId: string): Promise<boolean>

  Parameters

  • traceId: string

  Returns Promise<boolean>

recordSpanEnd

• recordSpanEnd(span: Span): Promise<Span>

  Records a span end. For a root span, finalizes the trace and emits trace-end (+ watch update). Returns the stored (merged) span.

  Parameters

  • span: Span

  Returns Promise<Span>

recordSpanStart

• recordSpanStart(span: Span): Promise<Span>

  Records a span start. Creates a running trace for a new root. Returns the stored (merged) span. Emits span-start (+ watch add for a new trace).

  Parameters

  • span: Span

  Returns Promise<Span>

subscribeTrace

• subscribeTrace(
      traceId: string,
      callback: (event: TraceStreamEvent) => void,
  ): () => void

  Subscribes to real-time updates for a specific trace. The callback is invoked for every Span change on this trace, for as long as the returned cleanup function has not been called.

  Optional — providers that cannot track live changes may omit it.

  Parameters

  • traceId: string
  • callback: (event: TraceStreamEvent) => void

  Returns () => void

  A no-argument function that cancels the subscription.

watch

• watch(callback: (event: TraceChangeEvent) => void): () => void

  Registers a callback invoked whenever a trace is added, updated, or removed. Used by the sidebar to stay in sync without polling.

  Optional — providers that cannot detect live changes may omit it.

  Parameters

  • callback: (event: TraceChangeEvent) => void

  Returns () => void

  A no-argument function that unregisters the watcher.