Skip to content

Add OpenAI Agents auto-instrumentation with real e2e coverage #1891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Stephen Belanger (Qard) merged 9 commits into from
May 21, 2026
Merged

Add OpenAI Agents auto-instrumentation with real e2e coverage #1891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
55d6278
Support auto-instrumentation of @openai/agents-core
Qard Apr 22, 2026
fef07c2
Address PR review feedback
Qard Apr 24, 2026
3c4cab8
fix(api-compat): remove openAIAgents from public BraintrustPluginConf…
May 6, 2026
c392c4f
fix(e2e): disable OpenAI trace exporter in openai-agents scenario
Qard May 19, 2026
79601b7
fix(e2e): add cassette for openai-agents-instrumentation scenario
Qard May 19, 2026
1335d0e
fix(e2e): fix formatting in openai-agents assertions
Qard May 19, 2026
69e3116
Add span tree snapshots
lforst May 21, 2026
eda6be8
Address PR review feedback
Qard May 21, 2026
18efe86
Restore openAIAgents on public InstrumentationConfig/BraintrustPlugin…
Qard May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/brave-clouds-trace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"braintrust": patch
---

feat: Add OpenAI Agents SDK auto-instrumentation
16 changes: 16 additions & 0 deletions e2e/config/pr-comment-scenarios.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@
}
]
},
{
"scenarioDirName": "openai-agents-instrumentation",
"label": "OpenAI Agents Instrumentation",
"metadataScenario": "openai-agents-instrumentation",
"variants": [
{ "variantKey": "openai-agents-auto-hook", "label": "Auto-hook" }
]
},
{
"scenarioDirName": "anthropic-instrumentation",
"label": "Anthropic Instrumentation",
Expand Down Expand Up @@ -162,5 +170,13 @@
{ "variantKey": "github-copilot-v0-wrapped", "label": "Wrapped" },
{ "variantKey": "github-copilot-v0-auto", "label": "Auto-hook" }
]
},
{
"scenarioDirName": "openai-agents-instrumentation",
"label": "OpenAI Agents Instrumentation",
"metadataScenario": "openai-agents-instrumentation",
"variants": [
{ "variantKey": "openai-agents-auto-hook", "label": "Auto-hook" }
]
}
]
215 changes: 215 additions & 0 deletions ...enarios/openai-agents-instrumentation/__cassettes__/openai-agents-auto-hook.cassette.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
{
"version": 1,
"meta": {
"createdAt": "2026-05-19T00:00:00.000Z",
"seinfeldVersion": "0.0.0"
},
"entries": [
{
"id": "a1b2c3d4e5f67890",
"matchKey": "POST api.openai.com/v1/responses",
"callIndex": 0,
"recordedAt": "2026-05-19T00:00:00.000Z",
"request": {
"method": "POST",
"url": "https://api.openai.com/v1/responses",
"headers": {
"accept": "application/json",
"authorization": "[REDACTED]",
"content-type": "application/json",
"user-agent": "Agents/JavaScript 0.0.14",
"x-stainless-arch": "arm64",
"x-stainless-lang": "js",
"x-stainless-os": "MacOS",
"x-stainless-package-version": "5.23.2",
"x-stainless-retry-count": "0",
"x-stainless-runtime": "node",
"x-stainless-runtime-version": "v26.0.0"
},
"body": {
"kind": "json",
"value": {
"instructions": "Use the lookup_weather tool exactly once, then answer only with the forecast.",
"model": "gpt-4o-mini",
"input": [
{
"role": "user",
"content": "What is the weather in Vienna? Answer only with the forecast."
}
],
"include": [],
"tools": [
{
"type": "function",
"name": "lookup_weather",
"description": "Look up the weather forecast for a city.",
"parameters": {
"type": "object",
"properties": {
"city": { "type": "string" }
},
"required": ["city"],
"additionalProperties": false
},
"strict": false
}
],
"temperature": 0,
"tool_choice": "required",
"stream": false
}
}
},
"response": {
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "application/json",
"openai-version": "2020-10-01",
"x-request-id": "req_a1b2c3d4e5f67890"
},
"body": {
"kind": "json",
"value": {
"id": "resp_a1b2c3d4e5f67890abcdef01",
"object": "response",
"created_at": 1777420003,
"model": "gpt-4o-mini-2024-07-18",
"status": "completed",
"completed_at": 1777420004,
"output": [
{
"id": "fc_a1b2c3d4e5f67890",
"type": "function_call",
"call_id": "call_a1b2c3d4e5f67890abcdef",
"name": "lookup_weather",
"arguments": "{\"city\":\"Vienna\"}",
"status": "completed"
}
],
"usage": {
"input_tokens": 85,
"output_tokens": 16,
"total_tokens": 101,
"input_tokens_details": { "cached_tokens": 0 },
"output_tokens_details": { "reasoning_tokens": 0 }
},
"error": null,
"incomplete_details": null
}
}
}
},
{
"id": "b2c3d4e5f6789012",
"matchKey": "POST api.openai.com/v1/responses",
"callIndex": 1,
"recordedAt": "2026-05-19T00:00:01.000Z",
"request": {
"method": "POST",
"url": "https://api.openai.com/v1/responses",
"headers": {
"accept": "application/json",
"authorization": "[REDACTED]",
"content-type": "application/json",
"user-agent": "Agents/JavaScript 0.0.14",
"x-stainless-arch": "arm64",
"x-stainless-lang": "js",
"x-stainless-os": "MacOS",
"x-stainless-package-version": "5.23.2",
"x-stainless-retry-count": "0",
"x-stainless-runtime": "node",
"x-stainless-runtime-version": "v26.0.0"
},
"body": {
"kind": "json",
"value": {
"instructions": "Use the lookup_weather tool exactly once, then answer only with the forecast.",
"model": "gpt-4o-mini",
"input": [
{
"role": "user",
"content": "What is the weather in Vienna? Answer only with the forecast."
},
{
"id": "fc_a1b2c3d4e5f67890",
"type": "function_call",
"call_id": "call_a1b2c3d4e5f67890abcdef",
"name": "lookup_weather",
"arguments": "{\"city\":\"Vienna\"}",
"status": "completed"
},
{
"type": "function_call_output",
"call_id": "call_a1b2c3d4e5f67890abcdef",
"output": "Sunny in Vienna"
}
],
"include": [],
"tools": [
{
"type": "function",
"name": "lookup_weather",
"description": "Look up the weather forecast for a city.",
"parameters": {
"type": "object",
"properties": {
"city": { "type": "string" }
},
"required": ["city"],
"additionalProperties": false
},
"strict": false
}
],
"temperature": 0,
"stream": false
}
}
},
"response": {
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "application/json",
"openai-version": "2020-10-01",
"x-request-id": "req_b2c3d4e5f6789012"
},
"body": {
"kind": "json",
"value": {
"id": "resp_b2c3d4e5f6789012abcdef02",
"object": "response",
"created_at": 1777420005,
"model": "gpt-4o-mini-2024-07-18",
"status": "completed",
"completed_at": 1777420006,
"output": [
{
"id": "msg_b2c3d4e5f6789012",
"type": "message",
"role": "assistant",
"status": "completed",
"content": [
{
"type": "output_text",
"text": "Sunny in Vienna"
}
]
}
],
"usage": {
"input_tokens": 110,
"output_tokens": 4,
"total_tokens": 114,
"input_tokens_details": { "cached_tokens": 0 },
"output_tokens_details": { "reasoning_tokens": 0 }
},
"error": null,
"incomplete_details": null
}
}
}
}
]
}
Loading
Loading