Skip to content

Commit 2d7cd80

Browse files
committed
fix(ag2): reuse the provider setup() registered instead of registering again
setup() without tracer_provider called fi register() on every call, so setup(planner) then setup(worker) put each agent on its own provider with its own AG2SpanProcessor. The planner's processor never saw the worker's invoke_agent span, kept the subtask rollup's promoted tokens, and the trace counted the worker's spend twice (real AG2: 91/15 input/output tokens against a UsageReport of 51/11). setup() now remembers the provider it registered and reuses it on later calls without tracer_provider until that provider is shut down. A later config= still replaces the installed TraceConfig; a different project_name is ignored with a warning. README and CHANGELOG updated. approved: Nikhil 2026-10-03 blanket Refs: TH-8236
1 parent 9c2c1bf commit 2d7cd80

6 files changed

Lines changed: 145 additions & 10 deletions

File tree

‎python/frameworks/ag2/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,10 @@
4747
dict, so `dropped_attributes_count` is no longer reset to 0 and the span's
4848
attribute limits still apply (a key the processor adds to a full span
4949
evicts the oldest one and is counted).
50+
- `setup()` without `tracer_provider` now registers a provider once and
51+
reuses it on later calls without one (until it is shut down) instead of
52+
calling `register()` again. Before, `setup(planner)` then `setup(worker)`
53+
gave each agent its own provider and `AG2SpanProcessor`, so the planner's
54+
processor never saw the worker's `invoke_agent` span and the worker's
55+
`record_usage subtask` rollup was counted on top of the worker's chat spans.
56+
A different `project_name` on a later call is ignored with a warning.

‎python/frameworks/ag2/README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,11 @@ offline example below is what the tests execute.
7373

7474
`setup(agent)` without `tracer_provider` calls
7575
`register(project_type=ProjectType.OBSERVE, project_name=project_name)` itself
76-
and returns the provider.
76+
and returns the provider. Later `setup()` calls without `tracer_provider`
77+
reuse that provider until it is shut down, so `setup(planner)` followed by
78+
`setup(worker)` gives both agents one provider and one `AG2SpanProcessor`. A
79+
different `project_name` on a later call is ignored with a warning; pass
80+
`tracer_provider=` to send agents to another project.
7781

7882
Agents created later, or per-call middleware:
7983

‎python/frameworks/ag2/tests/_support.py‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,33 @@ def memory_provider() -> "tuple[TracerProvider, InMemorySpanExporter]":
108108
return provider, exporter
109109

110110

111+
def fake_register(monkeypatch: Any) -> "tuple[InMemorySpanExporter, List[Optional[str]]]":
112+
"""Patch ``fi_instrumentation.register`` to build a new in-memory provider per call.
113+
114+
Every provider exports to one shared exporter, so spans split across
115+
providers still land in one place. ``calls`` records the ``project_name``
116+
of each call. Any provider an earlier test's ``setup()`` registered is
117+
forgotten for this test.
118+
"""
119+
import fi_instrumentation
120+
from opentelemetry.sdk.resources import Resource
121+
122+
import traceai_ag2._setup as setup_module
123+
124+
exporter = InMemorySpanExporter()
125+
calls: List[Optional[str]] = []
126+
127+
def register(*, project_type: Any = None, project_name: Optional[str] = None, **_: Any) -> TracerProvider:
128+
calls.append(project_name)
129+
provider = TracerProvider(resource=Resource.create({"project_name": project_name or ""}), shutdown_on_exit=False)
130+
provider.add_span_processor(SimpleSpanProcessor(exporter))
131+
return provider
132+
133+
monkeypatch.setattr(fi_instrumentation, "register", register)
134+
monkeypatch.setattr(setup_module, "_registered_provider", None, raising=False)
135+
return exporter, calls
136+
137+
111138
def attrs(span: ReadableSpan) -> Dict[str, Any]:
112139
return dict(span.attributes or {})
113140

‎python/frameworks/ag2/tests/test_setup.py‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
assert_no_content,
2929
attrs,
3030
expected_one_tool_kinds,
31+
fake_register,
3132
find,
3233
get_weather,
3334
memory_provider,
@@ -513,6 +514,46 @@ def test_setup_is_idempotent_per_agent():
513514
assert len(find(exporter.get_finished_spans(), "invoke_agent")) == 1
514515

515516

517+
def test_setup_without_provider_registers_once_and_reuses_it(monkeypatch):
518+
"""README: setup is idempotent. A second setup() without tracer_provider
519+
reuses the provider, and its one AG2SpanProcessor, from the first call
520+
instead of registering another; a later config still replaces the
521+
installed one."""
522+
exporter, calls = fake_register(monkeypatch)
523+
planner = weather_agent("planner")
524+
worker = weather_agent("worker")
525+
first = setup(planner, project_name="ag2-app")
526+
second = setup(worker, capture_content=True, config=TraceConfig(hide_inputs=True, hide_outputs=True))
527+
assert second is first
528+
assert calls == ["ag2-app"]
529+
chain = first._active_span_processor._span_processors
530+
assert sum(isinstance(p, AG2SpanProcessor) for p in chain) == 1
531+
ask(worker)
532+
spans = exporter.get_finished_spans()
533+
assert find(spans, "invoke_agent worker")
534+
for span in spans:
535+
assert_no_content(attrs(span), span.name)
536+
537+
538+
def test_setup_reusing_its_provider_warns_when_project_name_differs(monkeypatch, caplog):
539+
_, calls = fake_register(monkeypatch)
540+
first = setup(project_name="ag2-app")
541+
with caplog.at_level(logging.WARNING, logger="traceai_ag2"):
542+
assert setup(project_name="other-app") is first
543+
assert calls == ["ag2-app"]
544+
assert any("other-app" in r.getMessage() for r in caplog.records), caplog.text
545+
546+
547+
def test_setup_registers_again_after_its_provider_is_shut_down(monkeypatch):
548+
"""A provider the application shut down is not reused."""
549+
_, calls = fake_register(monkeypatch)
550+
first = setup(project_name="ag2-app")
551+
first.shutdown()
552+
second = setup(project_name="ag2-app")
553+
assert second is not first
554+
assert calls == ["ag2-app", "ag2-app"]
555+
556+
516557
def test_setup_names_middleware_after_each_agent():
517558
from ag2 import Agent
518559
from ag2.testing import TestConfig

‎python/frameworks/ag2/tests/test_usage_totals.py‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
from traceai_ag2 import setup
1818

19-
from ._support import attrs, emits_record_usage, memory_provider
19+
from ._support import attrs, emits_record_usage, fake_register, memory_provider
2020

2121
PROMOTED_INPUT = "gen_ai.usage.input_tokens"
2222
PROMOTED_OUTPUT = "gen_ai.usage.output_tokens"
@@ -181,6 +181,21 @@ def test_subtask_rollup_counts_once_when_worker_is_instrumented():
181181
_assert_trace_matches_report(spans, report)
182182

183183

184+
@needs_record_usage
185+
def test_subtask_counts_once_when_planner_and_worker_are_set_up_in_separate_calls(monkeypatch):
186+
"""setup(planner) then setup(worker), neither passing tracer_provider. Both
187+
must share one provider and one AG2SpanProcessor; otherwise the planner's
188+
processor never sees the worker's invoke_agent and keeps the rollup's
189+
tokens on top of the worker's own chat spans."""
190+
exporter, _ = fake_register(monkeypatch)
191+
worker = _worker()
192+
planner = _delegating_planner(worker)
193+
setup(planner)
194+
setup(worker)
195+
report = _run(planner, "plan")
196+
_assert_trace_matches_report(exporter.get_finished_spans(), report)
197+
198+
184199
@needs_record_usage
185200
def test_subtask_rollup_for_an_agent_seen_in_another_trace_keeps_tokens():
186201
"""Agent names are tracked per trace: an instrumented worker's earlier,

‎python/frameworks/ag2/traceai_ag2/_setup.py‎

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import contextlib
1313
import functools
1414
import logging
15+
import threading
1516
from typing import Any, Dict, Iterable, Optional
1617

1718
from fi_instrumentation.instrumentation.config import TraceConfig
@@ -198,6 +199,45 @@ def _has_telemetry_middleware(agent: Any) -> bool:
198199
return any(isinstance(m, TelemetryMiddleware) for m in entries)
199200

200201

202+
# The provider ``setup()`` registered itself (no ``tracer_provider`` given).
203+
# Later calls without one reuse it: a second ``register()`` would give the
204+
# later agents their own provider and ``AG2SpanProcessor``, which never sees
205+
# the earlier agents' spans, so a sub-task rollup would be counted twice.
206+
_registered_provider: Optional[TracerProvider] = None
207+
_register_lock = threading.Lock()
208+
209+
210+
def _is_shut_down(provider: Any) -> bool:
211+
"""``True`` once ``provider.shutdown()`` reached its ``AG2SpanProcessor``."""
212+
active = getattr(provider, "_active_span_processor", None)
213+
processors = getattr(active, "_span_processors", ())
214+
return any(isinstance(p, AG2SpanProcessor) and p._shutdown for p in processors)
215+
216+
217+
def _registered_or_new_provider(project_name: Optional[str]) -> TracerProvider:
218+
global _registered_provider
219+
with _register_lock:
220+
provider = _registered_provider
221+
if provider is not None and not _is_shut_down(provider):
222+
registered_name = getattr(getattr(provider, "resource", None), "attributes", {}).get("project_name")
223+
if project_name is not None and project_name != registered_name:
224+
logger.warning(
225+
"traceai-ag2: project_name %r is ignored; setup() reuses the provider it "
226+
"registered earlier for project %r. Pass tracer_provider= to send these "
227+
"agents elsewhere.",
228+
project_name,
229+
registered_name,
230+
)
231+
return provider
232+
233+
from fi_instrumentation import register
234+
from fi_instrumentation.fi_types import ProjectType
235+
236+
provider = register(project_type=ProjectType.OBSERVE, project_name=project_name)
237+
_registered_provider = provider
238+
return provider
239+
240+
201241
def setup(
202242
*agents: Any,
203243
tracer_provider: Optional[TracerProvider] = None,
@@ -218,10 +258,14 @@ def setup(
218258
``TelemetryMiddleware`` is skipped, so calling ``setup`` twice does
219259
not duplicate spans.
220260
tracer_provider: Provider from ``fi_instrumentation.register(...)``.
221-
When omitted, ``setup`` calls ``register(project_type=OBSERVE,
222-
project_name=project_name)`` itself (``FI_PROJECT_NAME``,
223-
``FI_API_KEY``, ``FI_SECRET_KEY`` and ``FI_BASE_URL`` apply).
224-
project_name: Used only when ``tracer_provider`` is omitted.
261+
When omitted, the first such ``setup`` call runs
262+
``register(project_type=OBSERVE, project_name=project_name)``
263+
(``FI_PROJECT_NAME``, ``FI_API_KEY``, ``FI_SECRET_KEY`` and
264+
``FI_BASE_URL`` apply) and later calls without one reuse that
265+
provider until it is shut down, so every agent shares one
266+
provider and one ``AG2SpanProcessor``.
267+
project_name: Used only when ``setup`` registers a provider; ignored,
268+
with a warning, when it differs from the one already registered.
225269
capture_content: Forwarded to ``TelemetryMiddleware``. Defaults to
226270
``False``, overriding AG2's upstream default of ``True``.
227271
provider_name, model_name, span_attributes, max_tool_result_chars:
@@ -240,10 +284,7 @@ def setup(
240284
before exiting.
241285
"""
242286
if tracer_provider is None:
243-
from fi_instrumentation import register
244-
from fi_instrumentation.fi_types import ProjectType
245-
246-
tracer_provider = register(project_type=ProjectType.OBSERVE, project_name=project_name)
287+
tracer_provider = _registered_or_new_provider(project_name)
247288
elif project_name is not None:
248289
logger.warning(
249290
"traceai-ag2: project_name is ignored when tracer_provider is passed; "

0 commit comments

Comments
 (0)