Context Trace Emitter • AI Agent SDK

ContextTraceEmitter: Emitter for context trace events.

ContextTraceEmitter

Defined in the Context Events module.

AI Agent

Emitter for context trace events.

Provides a high-level API for emitting context events during agent execution. Handles sequence numbering and redaction.

Constructor

ParamField Optional[ContextTraceSink]

No description available.

ParamField str

No description available.

ParamField bool

No description available.

ParamField bool

No description available.

ParamField bool

No description available.

Methods

set_branch()

Set current branch context for parallel execution tracking.

clear_branch()

Clear the current branch context.

session_start()

Emit session start event.

session_end()

Emit session end event.

agent_start()

Emit agent start event.

agent_end()

Emit agent end event.

message_added()

Emit message added event.

tool_call_start()

Emit tool call start event.

tool_call_end()

Emit tool call end event.

llm_request()

Emit LLM request event.

llm_response()

Emit LLM response event.

context_snapshot()

Emit context snapshot event with full context state.

agent_handoff()

Emit agent handoff event for tracking agent-to-agent flow.

workflow_start()

A team, flow or agent run begins. `graph` is its static graph.

workflow_end()

The innermost open team/flow run ends.

task_start()

A team task starts (node_id `task:name or index`).

task_end()

A team task ends: `completed, failed or skipped`.

step_start()

An AgentFlow step (or a Route/Parallel/Loop/… pattern) starts.

step_end()

A flow step ends: `completed, failed, skipped or cached`.

approval_requested()

A person is asked to approve a tool call or a task’s output.

approval_decided()

The decision for `approval_id` (parent_seq = the request).

memory_store()

Emit memory store event for tracking memory writes.

memory_search()

Emit memory search event for tracking memory reads.

knowledge_search()

Emit knowledge search event for tracking knowledge retrieval.

knowledge_add()

Emit knowledge add event for tracking knowledge indexing.

flush()

Flush the sink.

close()

Close the sink.

session_id()

Get the session ID.

enabled()

Check if emitter is enabled.

enabled()

Set enabled state.

Usage

python
sink = ContextListSink()
    emitter = ContextTraceEmitter(sink=sink, session_id="my-session")

    emitter.session_start()
    emitter.agent_start("researcher")
    emitter.message_added("researcher", "user", "Hello", 1, 10)
    emitter.agent_end("researcher")
    emitter.session_end()

Source

View on GitHub

praisonaiagents/trace/context_events.py at line 589


Related Documentation