Traces
Trace
Bases:ABC
A complete end-to-end workflow containing related spans and metadata.
A trace represents a logical workflow or operation (e.g., "Customer Service Query"or "Code Generation") and contains all the spans (individual operations) that occurduring that workflow.
Example
# Basic trace usagewithtrace("Order Processing")ast:validation_result=awaitRunner.run(validator,order_data)ifvalidation_result.approved:awaitRunner.run(processor,order_data)# Trace with metadata and groupingwithtrace("Customer Service",group_id="chat_123",metadata={"customer":"user_456"})ast:result=awaitRunner.run(support_agent,query)Notes
- Use descriptive workflow names
- Group related traces with consistent group_ids
- Add relevant metadata for filtering/analysis
- Use context managers for reliable cleanup
- Consider privacy when adding trace data
Source code insrc/agents/tracing/traces.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99100101102103104105106107108109110111112113114115116117118119120121122123124125 | |
trace_idabstractmethodproperty
Get the unique identifier for this trace.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | The trace's unique ID in the format 'trace_<32_alphanumeric>' |
Notes
- IDs are globally unique
- Used to link spans to their parent trace
- Can be used to look up traces in the dashboard
nameabstractmethodproperty
Get the human-readable name of this workflow trace.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | The workflow name (e.g., "Customer Service", "Data Processing") |
Notes
- Should be descriptive and meaningful
- Used for grouping and filtering in the dashboard
- Helps identify the purpose of the trace
startabstractmethod
Start the trace and optionally mark it as the current trace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mark_as_current | bool | If true, marks this trace as the current tracein the execution context. | False |
Notes
- Must be called before any spans can be added
- Only one trace can be current at a time
- Thread-safe when using mark_as_current
Source code insrc/agents/tracing/traces.py
finishabstractmethod
Finish the trace and optionally reset the current trace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reset_current | bool | If true, resets the current trace to the previoustrace in the execution context. | False |
Notes
- Must be called to complete the trace
- Finalizes all open spans
- Thread-safe when using reset_current
Source code insrc/agents/tracing/traces.py
exportabstractmethod
Export the trace data as a serializable dictionary.
Returns:
| Type | Description |
|---|---|
dict[str,Any] | None | dict | None: Dictionary containing trace data, or None if tracing is disabled. |
Notes
- Includes all spans and their data
- Used for sending traces to backends
- May include metadata and group ID
Source code insrc/agents/tracing/traces.py
NoOpTrace
Bases:Trace
A no-op implementation of Trace that doesn't record any data.
Used when tracing is disabled but trace operations still need to work.Maintains proper context management but doesn't store or export any data.
Example
Source code insrc/agents/tracing/traces.py
trace_idproperty
The trace's unique identifier.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | A unique ID for this trace. |
nameproperty
The workflow name for this trace.
Returns:
| Name | Type | Description |
|---|---|---|
str | str | Human-readable name describing this workflow. |
export
Export the trace data as a dictionary.
Returns:
| Type | Description |
|---|---|
dict[str,Any] | None | dict | None: Trace data in exportable format, or None if no data. |
TraceImpl
Bases:Trace
A trace that will be recorded by the tracing library.