Deployments.ai Docs
Command reference

deployments trace

Hot observability traces and execution trees

CommandSummary
deployments trace listList and filter recent traces
deployments trace showShow a finalized trace
deployments trace spansRender the spans in an execution trace
deployments trace for-runShow the trace containing a run
deployments trace sessionList traces for a session

deployments trace list

List and filter recent traces.

deployments trace list
  • Calls GET /v1/observability/traces (SDK listObservabilityTraces).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--fromstringStart of the bounded window (RFC 3339)
--tostringEnd of the bounded window (RFC 3339)
--statusstringTerminal trace outcome
--definitionstringRoot run agent definition ID
--deploymentstringRoot run agent deployment ID
--releasestringRoot run agent release ID
--purposestringRoot run execution purpose: customer, preview, or evaluation
--error-classstringTrace error class

Also accepts the global flags.

deployments trace show

Show a finalized trace.

deployments trace show --id <id>
FlagTypeRequiredDefaultDescription
--idstringyesTrace ID

Also accepts the global flags.

deployments trace spans

Render the spans in an execution trace.

deployments trace spans --id <id>
  • Calls GET /v1/observability/traces/{traceId}/spans (SDK listObservabilityTraceSpans).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--idstringyesTrace ID

Also accepts the global flags.

deployments trace for-run

Show the trace containing a run.

deployments trace for-run --run <run>
FlagTypeRequiredDefaultDescription
--runstringyesRun ID

Also accepts the global flags.

deployments trace session

List traces for a session.

deployments trace session --session <session>
  • Calls GET /v1/observability/sessions/{sessionId}/traces (SDK listObservabilitySessionTraces).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--sessionstringyesSession or thread ID
--fromstringStart of the bounded window (RFC 3339)
--tostringEnd of the bounded window (RFC 3339)
--statusstringTerminal trace outcome
--definitionstringRoot run agent definition ID
--deploymentstringRoot run agent deployment ID
--releasestringRoot run agent release ID
--purposestringRoot run execution purpose: customer, preview, or evaluation
--error-classstringTrace error class

Also accepts the global flags.

On this page