feat: add support for openai agents by minimAluminiumalism · Pull Request #161 · alibaba/loongsuite-python-agent

minimAluminiumalism · 2026-03-28T03:29:12Z

Description

Add OpenTelemetry instrumentation for the OpenAI Agents SDK, addressing #47.

The OpenAI Agents SDK ships with a built-in TracingProcessor callback interface that fires on every agent run, LLM call, and tool execution, etc. Instead of monkey-patching, this instrumentation registers a custom OTelTracingProcessor via add_trace_processor() that translates SDK spans into OTel spans following the GenAI semconv.

Implementation ref https://github.com/traceloop/openllmetry/tree/main/packages/opentelemetry-instrumentation-openai-agents

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test A

Does This PR Require a Core Repo Change?

Yes. - Link to PR:
No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

Copilot

Pull request overview

Adds a new LoongSuite/OpenTelemetry instrumentation package for the OpenAI Agents SDK by registering a custom TracingProcessor that converts SDK trace/span callbacks into OTel spans using GenAI semantic conventions.

Changes:

Introduces OTelTracingProcessor to translate OpenAI Agents SDK spans/traces into OpenTelemetry spans.
Adds an OpenAIAgentsInstrumentor that registers/unregisters the processor via the SDK tracing API.
Adds packaging/docs/tests scaffolding for the new instrumentation distribution.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/_processor.py	Implements the SDK `TracingProcessor` bridge and span translation logic.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/init.py	Implements the instrumentor that registers/unregisters the tracing processor.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/package.py	Declares instrumented dependency metadata for the distribution.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/version.py	Adds package version for hatch dynamic versioning.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/test_processor.py	Unit tests validating span creation/attributes for supported SDK span types.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/test_instrumentor.py	Tests instrumentor lifecycle and processor registration.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/conftest.py	Pytest fixtures + env configuration for GenAI semconv/content capture.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/init.py	Marks tests as a package (license header only).
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/requirements.oldest.txt	Pins oldest supported `openai-agents` version for test matrix.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/tests/requirements.latest.txt	Uses latest `openai-agents` for test matrix.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/README.rst	Adds end-user installation/usage documentation.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/pyproject.toml	Adds build metadata, deps, and entry point registration.
instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/CHANGELOG.md	Introduces initial changelog entry for the new package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-31T01:07:20Z

+        try:
+            from agents.tracing.setup import (  # noqa: PLC0415
+                get_trace_provider,
+            )
+
+            provider = get_trace_provider()
+            if hasattr(provider, "_multi_processor"):
+                mp = provider._multi_processor
+                if hasattr(mp, "_processors"):
+                    procs = mp._processors
+                    if processor in procs:
+                        procs.remove(processor)
+        except Exception as e:
+            logger.debug("Failed to remove processor: %s", e)
+


_uninstrument() removes the processor by reaching into private SDK internals (provider._multi_processor._processors). This is brittle across SDK versions and may silently fail (leaving the processor registered and causing duplicate spans on re-instrumentation). If the Agents SDK provides a public removal API, prefer that; otherwise consider making the failure mode explicit (e.g., warn once) and/or add defensive checks around processor duplication on _instrument().

Suggested change

try:

from agents.tracing.setup import ( # noqa: PLC0415

get_trace_provider,

)

provider = get_trace_provider()

if hasattr(provider, "_multi_processor"):

mp = provider._multi_processor

if hasattr(mp, "_processors"):

procs = mp._processors

if processor in procs:

procs.remove(processor)

except Exception as e:

logger.debug("Failed to remove processor: %s", e)

removed = False

# Prefer a public removal API from the Agents SDK if available.

try:

from agents.tracing import ( # type: ignore[attr-defined] # noqa: PLC0415

remove_trace_processor,

)

except Exception: # ImportError or absence of public API

remove_trace_processor = None # type: ignore[assignment]

if remove_trace_processor is not None: # type: ignore[truthy-function]

try:

remove_trace_processor(processor) # type: ignore[call-arg]

removed = True

except Exception as e:

logger.warning(

"Failed to remove OpenAI Agents tracing processor via "

"public API: %s. Falling back to SDK internals.",

e,

)

# Fallback: best-effort removal via SDK internals, with explicit warnings

if not removed:

try:

from agents.tracing.setup import ( # noqa: PLC0415

get_trace_provider,

)

provider = get_trace_provider()

if hasattr(provider, "_multi_processor"):

mp = provider._multi_processor

if hasattr(mp, "_processors"):

procs = mp._processors

if processor in procs:

procs.remove(processor)

removed = True

if not removed:

logger.warning(

"OpenAI Agents tracing processor could not be "

"located in the trace provider; it may still be "

"registered, which can lead to duplicate spans on "

"re-instrumentation."

)

except Exception as e:

logger.warning(

"Failed to remove OpenAI Agents tracing processor via "

"trace provider internals; the processor may still be "

"registered, which can lead to duplicate spans on "

"re-instrumentation: %s",

e,

)

The OpenAI Agents SDK does not expose a public API to remove a trace processor. add_trace_processor exists but there is no corresponding remove_trace_processor.
The private attribute fallback with hasattr guards is the only viable approach.

Cirilla-zmh · 2026-04-01T10:21:15Z

+    "OTEL_SEMCONV_STABILITY_OPT_IN", "gen_ai_latest_experimental"
+)
+os.environ.setdefault(
+    "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT", "true"


OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT should be set as SPAN_ONLY.

github-actions · 2026-04-16T04:27:37Z

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

Adds openai-agents test/lint envs to tox-loongsuite.ini (envlist, deps, commands) and regenerates the loongsuite workflow YAMLs via `tox -e generate-workflows`, addressing Cirilla-zmh's review request on tests/test_instrumentor.py.

…gent into feat/openai-agents Resolves tox-loongsuite.ini conflict: keeps the openai-agents test/lint deps block and adopts upstream's renamed `agno`/`dify`/`mem0`/etc. deps keys (the `loongsuite-` prefix was dropped on main). Regenerates the loongsuite workflow YAMLs from the resolved tox config.

github-actions Bot assigned 123liuziming, Cirilla-zmh and ralf0131 Mar 28, 2026

github-actions Bot requested review from 123liuziming, Cirilla-zmh and ralf0131 March 28, 2026 03:29

ralf0131 requested a review from Copilot March 31, 2026 01:01

Copilot started reviewing on behalf of ralf0131 March 31, 2026 01:02 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Cirilla-zmh reviewed Apr 1, 2026

View reviewed changes

Comment thread instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/README.rst

Cirilla-zmh reviewed Apr 1, 2026

View reviewed changes

Comment thread instrumentation-loongsuite/loongsuite-instrumentation-openai-agents/CHANGELOG.md

minimAluminiumalism added 4 commits April 1, 2026 21:36

feat: add support for openai agents

b85b84b

chore: add license header

a2afd26

fix comments

4796ce8

fix comments

d73a674

minimAluminiumalism force-pushed the feat/openai-agents branch from 527e2cf to d73a674 Compare April 1, 2026 13:46

fix comments

0b49bde

github-actions Bot added the Stale label Apr 16, 2026

minimAluminiumalism added 2 commits April 19, 2026 12:36

github-actions Bot removed the Stale label Apr 20, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for openai agents#161

feat: add support for openai agents#161
minimAluminiumalism wants to merge 7 commits intoalibaba:mainfrom
minimAluminiumalism:feat/openai-agents

minimAluminiumalism commented Mar 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

minimAluminiumalism Apr 1, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Cirilla-zmh Apr 1, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

minimAluminiumalism commented Mar 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

minimAluminiumalism Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Cirilla-zmh Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

minimAluminiumalism commented Mar 28, 2026 •

edited

Loading