Using traces with ADK CLI

Use the watsonx Orchestrate ADK CLI to search for traces from your active environment and export their observations.

Searching traces

Use filters to search for traces and identify trace IDs.

BASH

orchestrate observability traces search --start-time <start date and time for search> --end-time <end date and time for search>

Show command flags

datetime

A start time for the results (ISO 8601 format). Required when --last is not used. Must be used together with --end-time. Cannot be used with --last.

datetime

An end time for the results (ISO 8601 format). Required when --last is not used. Must be used together with --start-time. Cannot be used with --last.

string

A shorthand for a relative time window that ends now. You can enter:

Minutes. For example: 30m / 30 minutes
Hours. For example: 3h / 3 hours
Days. For example: 10d / 10 days

Cannot be used with --start-time or --end-time.

string

A user ID to filter results. Can be specified multiple times.

string

A session ID to filter results. Can be specified multiple times.

int

A limit on the number of traces returned. Configure a value from 1 to 1000. Default is 100.

SortField

A field used for sorting results. Accepted values: start_time, end_time. Default is start_time.

SortDirection

A sort direction for the results. Accepted values: asc, desc. Default is desc.

string

deprecated

Deprecated. Service name filtering is no longer supported. Accepted for backward compatibility but ignored.

string

deprecated

Deprecated. Agent ID filtering is no longer supported. Accepted for backward compatibility but ignored.

string

deprecated

Deprecated. Agent name filtering is no longer supported. Accepted for backward compatibility but ignored.

int

deprecated

Deprecated. Span count filtering is no longer supported. Accepted for backward compatibility but ignored.

int

deprecated

Deprecated. Span count filtering is no longer supported. Accepted for backward compatibility but ignored.

After you identify the trace IDs, run orchestrate observability traces export to export the full trace data.

Exporting trace observations

Export observations for a trace from the watsonx Orchestrate observability platform. The command fetches all observations for a specific trace ID and writes them to a file or to standard output in JSON format.

BASH

orchestrate observability traces export --trace-id <trace ID>

Show command flags

string

required

A trace ID to export.

string

A file path for the command output. When omitted, output is displayed in the CLI.

NoteThe output file must be in JSON format. When a different file type is provided, a warning is shown.

bool

Indented JSON output for easier readability. This flag is used only with the --output / -o flag. Default is --pretty.

Release Notes

Get Started

Build

Deploy

Analyze

Developer experience

Legal notices

Searching traces

Exporting trace observations

​Searching traces

​Exporting trace observations

Searching traces

Exporting trace observations