🐛 Bug Report: OpenAI instrumentation drops gen_ai.usage.reasoning_tokens on streamed chat completions
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- observability
Research direction
Read shared/chat_wrappers.py, especially _handle_response and _set_streaming_token_metrics, then inspect tests/traces/test_chat.py and test_chat_reasoning. Add streamed coverage for a usage chunk with completion_tokens_details.reasoning_tokens; done means the streamed span records gen_ai.usage.reasoning_tokens alongside its token metrics. The issue author offers to submit a PR, but no assignee or linked pull request is reported.
Written by the indexing model from the issue text.
Description
Which component is this bug for?
OpenAI Instrumentation
📜 Description
A streamed chat completion never gets gen_ai.usage.reasoning_tokens, even when its usage chunk carries completion_tokens_details.reasoning_tokens. Without stream=True the span records it.
Only _handle_response sets the attribute (shared/chat_wrappers.py:334-354 at 8d9c93f), since #3336. Every stream path, async included, goes through _set_streaming_token_metrics (chat_wrappers.py:615), which sets input and output tokens and nothing else. The semantic-conventions page defines it as the reasoning part of completion_tokens, with no exception for streams. The only test, test_chat_reasoning (tests/traces/test_chat.py:1449), makes a non-stream call.
👟 Reproduction steps
- At
8d9c93f:pip install -e packages/opentelemetry-semantic-conventions-ai -e packages/opentelemetry-instrumentation-openai openai==3.35.1 opentelemetry-sdk. - Run this (a mock transport, no network):
import json
import httpx
import openai
from opentelemetry.instrumentation.openai import OpenAIInstrumentor
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
exporter = InMemorySpanExporter()
provider = TracerProvider()
provider.add_span_processor(SimpleSpanProcessor(exporter))
OpenAIInstrumentor().instrument(tracer_provider=provider)
USAGE = {"prompt_tokens": 12, "completion_tokens": 300, "total_tokens": 312,
"completion_tokens_details": {"reasoning_tokens": 256}}
BASE = {"id": "c1", "created": 0, "model": "o4-mini"}
def handler(request):
if json.loads(request.content).get("stream"):
chunks = [
BASE | {"object": "chat.completion.chunk", "choices": [{"index": 0, "delta": {
"role": "assistant", "content": "Paris."}, "finish_reason": "stop"}]},
BASE | {"object": "chat.completion.chunk", "choices": [], "usage": USAGE},
]
body = "".join(f"data: {json.dumps(c)}\n\n" for c in chunks) + "data: [DONE]\n\n"
return httpx.Response(200, content=body.encode(),
headers={"content-type": "text/event-stream"})
return httpx.Response(200, json=BASE | {"object": "chat.completion", "usage": USAGE,
"choices": [{"index": 0, "message": {"role": "assistant", "content": "Paris."},
"finish_reason": "stop"}]})
client = openai.OpenAI(api_key="x", http_client=httpx.Client(transport=httpx.MockTransport(handler)))
for stream in (False, True):
kw = {"stream_options": {"include_usage": True}} if stream else {}
resp = client.chat.completions.create(model="o4-mini", stream=stream,
messages=[{"role": "user", "content": "Capital of France?"}], **kw)
if stream:
for _ in resp:
pass
a = exporter.get_finished_spans()[-1].attributes
print(f"stream={stream!s:<5} output_tokens={a.get('gen_ai.usage.output_tokens')} "
f"reasoning_tokens={a.get('gen_ai.usage.reasoning_tokens')}")
exporter.clear()
👍 Expected behavior
Both spans carry gen_ai.usage.reasoning_tokens=256.
👎 Actual Behavior with Screenshots
$ python repro_openai.py
stream=False output_tokens=300 reasoning_tokens=256
stream=True output_tokens=300 reasoning_tokens=None
🤖 Python Version
3.12
📃 Provide any additional context for the Bug.
I ran the sync stream only, and read the async path from the code.
👀 Have you spent some time to check if this bug has been raised before?
- I checked and didn't find similar issue
- Searched open and closed issues and pull requests for
reasoning_tokensandreasoning streaming. #4458, #4461 and #4462 cover Anthropic, #4488 covers Groq. No open pull request addsreasoningtochat_wrappers.py.
- Searched open and closed issues and pull requests for
Are you willing to submit PR?
Yes I am willing to submit a PR!
@doronkopit5, I'd move the reasoning block into a helper that _handle_response and _set_streaming_token_metrics both call, so every stream path gets it, plus a streamed twin of test_chat_reasoning. Shall I open it?
- Dominant language
- Python
- Stars
- 7.5k
- Forks
- 1.2k
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from traceloop/openllmetry
-
bug python
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
traceloop/openllmetry#4717 ·
Maintainers usually reply within 1 day
-
🐛 Bug Report: Incomplete cache token migration after #4243 breaks Bedrock and Groq instrumentationPossibly taken @Quantum-Enigma-dot claimed this 21 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
traceloop/openllmetry#4665 · 1 comment ·
Maintainers usually reply within 1 day
-
Bug Report: Failed dataset deletes still remove local rows and columnsPossibly taken @inchang-ing claimed this 32 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
traceloop/openllmetry#4630 ·
Maintainers usually reply within 1 day
-
🐛 Bug Report: LiteLLM instrumentation does not record seed, stop, frequency_penalty, presence_penaltyPossibly taken @shantam77 claimed this 38 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
traceloop/openllmetry#4598 · 2 comments ·
Maintainers usually reply within 1 day
-
🐛 Bug Report: LiteLLM instrumentation never ends the span when a call is interrupted (KeyboardInterrupt, asyncio cancellation)Possibly taken @rupak-eng claimed this 39 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
traceloop/openllmetry#4597 · 1 comment ·
Maintainers usually reply within 1 day
All issues in traceloop/openllmetry
Similar issues
-
Internal ErrorOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
frappe/frappe_docker#2071 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
The-Pocket/PocketFlow#161 ·
-
comp/desktop P2 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NousResearch/hermes-agent#157702 ·
Maintainers usually reply within 1 day
-
scibench_physics / scibench_chemistry: a correct answer scores 0 when the unit has a power of tenPossibly taken @BahaaMattar claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
EvolvingLMMs-Lab/lmms-eval#1699 ·
Maintainers usually reply within 1 day
-
project_inputs.html uses undefined file variable for dropdown IDs, lacks visual tag badges, and has empty delete labelsPossibly taken @Rucha0901 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
aboutcode-org/scancode.io#2354 ·
Maintainers usually reply within 1 day