docs: add OrcaReplay to external tracing processors list - #5043
Draft
xizhuomengcontin wants to merge 1 commit into
Draft
xizhuomengcontin wants to merge 1 commit into
xizhuomengcontin wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds OrcaReplay to the existing external tracing processors list — one line,
docs/tracing.md.The published
orcareplay-openai-agentsimplements the SDK's ownTracingProcessorsurface —on_trace_start,on_trace_end,on_span_start,on_span_end,shutdown,force_flush— and registers throughset_trace_processors(), oradd_trace_processor()when the SDK's own exporter is to be kept alongside it.It exports bounded, metadata-only spans, and only the three types its reader consumes:
AgentSpanDataname,handoffs,tools,output_typeHandoffSpanDatafrom_agent,to_agentGuardrailSpanDataname,triggeredEverything else is dropped, including every other span type. Raw prompts, model output, tool arguments, tool results,
mcp_data,CustomSpanDatapayloads, transcription and speech audio, andSpanError.datanever reach the file — an allow-list rather than a deny-list, so a field a future SDK version adds stays out without a code change.ResponseSpanDataandGenerationSpanDataare dropped for a second reason as well: OrcaReplay records model traffic at a proxy and already holds those exchanges byte for byte, so a second copy would be a lossier duplicate of the same conversation.What the tracing data is for: OrcaReplay records a run and replays it offline, and the three span types above are the part of a run a proxy cannot reconstruct. A handoff reaches the wire as a
transfer_to_<agent>function tool, which names the destination and never the source; a guardrail that passes need make no request at all. Verified against openai-agents 0.20.0 and 0.22.2.The linked page is the integration's own README: install, the interface it implements, what it writes, and how to turn it off.
Test plan
Docs-only,
+1/-0indocs/tracing.md. No code paths are touched, and the entry follows the existing format and position of the list.The link target was checked after the package was published:
pip install orcareplay-openai-agentson a clean interpreter, then a two-agent run with a handoff and a guardrail, which producedagent.start×2,agent.handoffandagent.guardrailthrough the processor — on 0.22.2, two minor versions past the one it was written against.I did not run
.agents/skills/code-change-verification/scripts/run.sh: it drives the repository'smaketargets and needs the full uv dev environment, which is unrelated to a one-line markdown addition. Happy to run it if you would rather I did.Issue number
n/a
Checks
.agents/skills/code-change-verification/scripts/run.sh— see Test plan/reviewbefore submitting this PR — not using Codex