Skip to content

Python: Fix FoundryAgent telemetry gaps for name and model (Fixes #5088)#5094

Open
Charanvardhan wants to merge 2 commits intomicrosoft:mainfrom
Charanvardhan:fix-foundry-telemetry-5088
Open

Python: Fix FoundryAgent telemetry gaps for name and model (Fixes #5088)#5094
Charanvardhan wants to merge 2 commits intomicrosoft:mainfrom
Charanvardhan:fix-foundry-telemetry-5088

Conversation

@Charanvardhan
Copy link
Copy Markdown

@Charanvardhan Charanvardhan commented Apr 4, 2026

Motivation and Context

This PR addresses two telemetry gaps present in the FoundryAgent implementation where essential OpenTelemetry instrumentation fields were either rendering erroneously as a UUID or not populating at all.

Fixes #5088

Description

This change ensures that gen_ai.agent.name and gen_ai.request.model output appropriately for telemetry and Application Insights tracing.

  • Agent Name fallback: In _agent.py, RawFoundryAgent.__init__ now correctly falls back to getattr(client, 'agent_name') if name is omitted, rather than allowing the base classes to arbitrarily generate a random UUID.
  • Request Model Lazy-Loading: Because Managed Foundry Agents dictate their models entirely server-side, RawFoundryAgentChatClient now implements an asynchronous lazy invocation to project_client.agents.get_agent inside _prepare_options. It securely caches the return response locally, directly updates the opentelemetry current span dynamically before tracing is flushed, and exposes a .model property for all subsequent calls.
  • Unit Tests: Additionally includes the test_foundry_agent_telemetry_defaults test using AsyncMock to rigorously assert these edge configurations.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

…rosoft#5088)

Resolves gen_ai.agent.name rendering as UUID and gen_ai.request.model rendering as 'unknown' by falling back to the client agent definition and lazily resolving the Azure AI Projects SDK request model on first fetch.
Copilot AI review requested due to automatic review settings April 4, 2026 06:32
@microsoft-github-policy-service
Copy link
Copy Markdown

@Charanvardhan please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to close telemetry gaps in the Python Foundry agent integration by ensuring gen_ai.agent.name uses a stable, human-readable fallback (agent name) and by resolving gen_ai.request.model from the Azure AI Projects agent definition (rather than reporting "unknown").

Changes:

  • Add a fallback for FoundryAgent.name to use the underlying client’s agent_name when name=None.
  • Add lazy model resolution via project_client.agents.get_agent(...) and attempt to patch the current OTel span with the resolved model.
  • Add a unit test validating the name fallback and lazy model fetch behavior.

Reviewed changes

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

File Description
python/packages/foundry/agent_framework_foundry/_agent.py Adds name fallback behavior and introduces lazy model resolution + span mutation logic.
python/packages/foundry/tests/foundry/test_foundry_agent.py Adds a test covering the new name/model telemetry defaults behavior.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.


@model.setter
def model(self, value: str) -> None:
pass
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

model is defined as a property, but the setter is a no-op. Because RawFoundryAgentChatClient subclasses RawOpenAIChatClient, RawOpenAIChatClient.__init__ assigns self.model = ... (openai/_chat_client.py:446); with the current no-op setter, that assignment is silently discarded, and any later client.model = ... will also do nothing. Implement the setter to persist the value (e.g., set the backing field used by the getter) or remove the property and use a normal attribute/backing field so assignments behave correctly.

Suggested change
pass
self._fetched_model = value

Copilot uses AI. Check for mistakes.
Comment on lines +281 to +288
# Lazily fetch the model name if not already cached
if not hasattr(self, "_fetched_model"):
try:
agent = await self.project_client.agents.get_agent(self.agent_name)
self._fetched_model = getattr(agent, "model", "unknown")
except Exception:
self._fetched_model = "unknown"

Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lazy model fetch uses if not hasattr(self, "_fetched_model") and then awaits project_client.agents.get_agent(...). If two calls enter _prepare_options concurrently before _fetched_model is set, both will perform the network call. Consider guarding the lazy initialization with an asyncio.Lock or an in-flight Task/Future so only one fetch occurs and others await it.

Copilot uses AI. Check for mistakes.
Comment on lines +283 to +302
try:
agent = await self.project_client.agents.get_agent(self.agent_name)
self._fetched_model = getattr(agent, "model", "unknown")
except Exception:
self._fetched_model = "unknown"

# Try to update the current OpenTelemetry span directly
if hasattr(self, "_fetched_model") and self._fetched_model != "unknown":
try:
from opentelemetry import trace
from agent_framework.observability import OtelAttr

current_span = trace.get_current_span()
if current_span and current_span.is_recording():
current_span.set_attribute(OtelAttr.REQUEST_MODEL, self._fetched_model)
span_name_parts = current_span.name.split(" ", 1)
if len(span_name_parts) > 0:
current_span.update_name(f"{span_name_parts[0]} {self._fetched_model}")
except Exception:
pass
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The except Exception blocks here swallow all failures (including auth/config/service errors) and then suppress them again when updating OTEL, with no logging. This can make real regressions very hard to diagnose and permanently cache "unknown" after a transient error. Prefer catching expected exception types (e.g., ImportError separately, and the specific Azure SDK error types for get_agent) and logging at least a debug/warning message once when resolution fails.

Copilot uses AI. Check for mistakes.
Comment on lines +289 to +301
# Try to update the current OpenTelemetry span directly
if hasattr(self, "_fetched_model") and self._fetched_model != "unknown":
try:
from opentelemetry import trace
from agent_framework.observability import OtelAttr

current_span = trace.get_current_span()
if current_span and current_span.is_recording():
current_span.set_attribute(OtelAttr.REQUEST_MODEL, self._fetched_model)
span_name_parts = current_span.name.split(" ", 1)
if len(span_name_parts) > 0:
current_span.update_name(f"{span_name_parts[0]} {self._fetched_model}")
except Exception:
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating the OpenTelemetry span via trace.get_current_span() won’t work for streaming requests: ChatTelemetryLayer intentionally creates streaming spans without context attachment (core/agent_framework/observability.py:1293-1299), so there may be no “current span” to update. As a result, gen_ai.request.model can still remain unknown for stream=True. Consider a mechanism that ensures the span used for the request is the one being updated (e.g., providing the model before span creation, or passing/propagating the span explicitly).

Copilot uses AI. Check for mistakes.
agent = FoundryAgent(
project_client=mock_project,
agent_name="my-telemetry-agent",
name=None # Explicitly None to test fallback
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This multiline FoundryAgent(...) call is missing a trailing comma after the last argument. In this repo most multiline call sites include trailing commas (and formatters like Black will typically add them), so adding it will avoid churn / formatting diffs.

Suggested change
name=None # Explicitly None to test fallback
name=None, # Explicitly None to test fallback

Copilot uses AI. Check for mistakes.
@Charanvardhan
Copy link
Copy Markdown
Author

@copilot apply changes based on the comments in this thread

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FoundryAgent telemetry: gen_ai.agent.name defaults to UUID, gen_ai.request.model is "unknown"

3 participants