🐛 Bug Report: OpenAI instrumentation drops gen_ai.usage.reasoning_tokens on streamed chat completions
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 82/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- observability
Línea de trabajo
Lee shared/chat_wrappers.py, especialmente _handle_response y _set_streaming_token_metrics, y después revisa tests/traces/test_chat.py y test_chat_reasoning. Añade cobertura del flujo para un fragmento de uso con completion_tokens_details.reasoning_tokens; la tarea estará completa cuando el span del flujo registre gen_ai.usage.reasoning_tokens junto con sus métricas de tokens. El autor del issue se ofrece a enviar un PR, pero no se indica ningún asignado ni pull request vinculado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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?
- Lenguaje dominante
- Python
- Estrellas
- 7.5k
- Forks
- 1.2k
- Merge medio
- 2 d 6 h
- PR fusionados (30 d)
- 2
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de traceloop/openllmetry
-
bug python
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
traceloop/openllmetry#4717 ·
Los mantenedores suelen responder en 1 día
-
🐛 Bug Report: Incomplete cache token migration after #4243 breaks Bedrock and Groq instrumentationPosiblemente ocupada @Quantum-Enigma-dot la tomó hace 21 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
traceloop/openllmetry#4665 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Bug Report: Failed dataset deletes still remove local rows and columnsPosiblemente ocupada @inchang-ing la tomó hace 32 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
traceloop/openllmetry#4630 ·
Los mantenedores suelen responder en 1 día
-
🐛 Bug Report: LiteLLM instrumentation does not record seed, stop, frequency_penalty, presence_penaltyPosiblemente ocupada @shantam77 la tomó hace 38 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
traceloop/openllmetry#4598 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
🐛 Bug Report: LiteLLM instrumentation never ends the span when a call is interrupted (KeyboardInterrupt, asyncio cancellation)Posiblemente ocupada @rupak-eng la tomó hace 39 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
traceloop/openllmetry#4597 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de traceloop/openllmetry
Issues similares
-
Internal ErrorAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
frappe/frappe_docker#2071 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
The-Pocket/PocketFlow#161 ·
-
[Bug]: Webapp workspace fails to render in Safari — "Can't find variable: requestIdleCallback"Abiertocomp/desktop P2 type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#157702 ·
Los mantenedores suelen responder en 1 día
-
scibench_physics / scibench_chemistry: a correct answer scores 0 when the unit has a power of tenPosiblemente ocupada @BahaaMattar la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
EvolvingLMMs-Lab/lmms-eval#1699 ·
Los mantenedores suelen responder en 1 día
-
project_inputs.html uses undefined file variable for dropdown IDs, lacks visual tag badges, and has empty delete labelsPosiblemente ocupada @Rucha0901 la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
aboutcode-org/scancode.io#2354 ·
Los mantenedores suelen responder en 1 día