fix tracing for operation id to flow in exception table. by harsheet-shah · Pull Request #47387 · Azure/azure-sdk-for-python

harsheet-shah · 2026-06-08T04:48:22Z

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

github-actions · 2026-06-08T04:48:46Z

Thank you for your contribution @harsheet-shah! We will review the pull request and get back to you soon.

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates ASGI tracing middleware to ensure logs emitted after request handling (notably Hypercorn access logs) still carry the correct OpenTelemetry trace context, preventing zeroed operation_Id in Application Insights.

Changes:

Creates a NonRecordingSpan from extracted trace context so get_current_span() exposes the correct trace_id.
Attaches the extracted context for the duration of the task and removes the previous detach() in finally to keep context available for post-response logging.

singankit · 2026-06-08T06:49:40Z

+        span = trace.get_current_span(ctx)
+        span_ctx = span.get_span_context()
+        if span_ctx and span_ctx.trace_id:
+            non_recording = trace.NonRecordingSpan(span_ctx)


Why do we need to create a non-recording span ?

We should validate consequent request and how traces show up.

yes @singankit I've validated pls check this query - https://ms.portal.azure.com#@72f988bf-86f1-41af-91ab-2d7cd011db47/blade/Microsoft_OperationsManagementSuite_Workspace/Logs.ReactView/resourceId/%2Fsubscriptions%2F47f1c914-e299-4953-a99d-3e34644cfe1c%2FresourceGroups%2Fharsheetrg%2Fproviders%2Fmicrosoft.insights%2Fcomponents%2Fharsheet-app-insights-debug/source/LogsBlade.AnalyticsShareLinkToQuery/q/H4sIAAAAAAAAA0utSE4tKMnMzyvmqlEoz0gtSlUoycxNLS5JzC1QsLNVKMlPSSxJBQlpqBsZGJnpGoBQiKGplZGJlYGBnoWZqZGxRZS6JlB7cX5RiUJSJZIBicXJAH4x9HdhAAAA/limit/1000

Defer context detach by one event-loop turn so post-response access logging can still observe request trace context, while still restoring prior context to prevent leakage. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

+                await asyncio.sleep(0)
+                detach_mock.assert_called_once_with("token")
+
+        asyncio.run(run_test())


+                await asyncio.sleep(0)
+                detach_mock.assert_called_once_with("token")
+
+        asyncio.run(run_test())


Copilot

Pull request overview

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

+            with mock.patch("azure.ai.agentserver.core._tracing._otel_context.attach", return_value="token") as attach_mock, \
+                    mock.patch("azure.ai.agentserver.core._tracing._otel_context.detach") as detach_mock:
+                await middleware(scope, receive, send)
+                assert events == ["app-called"]
+                attach_mock.assert_called_once()
+                detach_mock.assert_not_called()
+
+                await asyncio.sleep(0)
+                detach_mock.assert_called_once_with("token")


Validate detach_context swallows ValueError so call_soon(detach_context, token) cannot surface non-current-token detach errors as unhandled callback failures. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

This reverts commit 66ae7a2.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Use a dedicated safe callback for call_soon detaches and keep ValueError suppression behavior for invalid/non-current tokens without regressing deferred-detach tracing fix. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Use call_soon(detach_context, token) directly and keep ValueError handling in detach_context to avoid callback noise while preserving deferred trace context behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Use an explicit deferred callback helper that detaches the attached token and swallows ValueError to avoid unhandled callback noise while preserving delayed context cleanup. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Wrap deferred detach scheduling in try/except and fall back to immediate best-effort detach so token cleanup still happens when the event loop is closing/closed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Route both call_soon callback and scheduling-failure fallback through detach_context(token) to keep detach semantics centralized and consistent. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Add agent name/version and sessionid dimensions to log records via OTel log processor while retaining baggage propagation and span enrichment. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Resolve agent name/version from AGENT_* env pairs when FOUNDRY_AGENT_* is absent, and remove gen_ai.agent.sessionid to rely on existing azure.ai.agentserver.session_id baggage field. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

fix tracing for operation id to flow in exception table.

1ba43a4

Copilot AI review requested due to automatic review settings June 8, 2026 04:48

harsheet-shah requested review from RaviPidaparthi, ankitbko and vangarp as code owners June 8, 2026 04:48

github-actions Bot added Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. Hosted Agents sdk/agentserver/* labels Jun 8, 2026

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py Outdated

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py

singankit reviewed Jun 8, 2026

View reviewed changes

harsheet-shah requested a review from Copilot June 8, 2026 08:06

Copilot AI reviewed Jun 8, 2026

View reviewed changes

harsheet-shah requested a review from Copilot June 8, 2026 08:09

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Harsheet Shah and others added 6 commits June 8, 2026 13:46

Add test for safe deferred OTel detach

66ae7a2

Validate detach_context swallows ValueError so call_soon(detach_context, token) cannot surface non-current-token detach errors as unhandled callback failures. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Revert "Add test for safe deferred OTel detach"

01c74fe

This reverts commit 66ae7a2.

Reset test_tracing.py to main

52a9c9b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Harden deferred OTel detach callback

f4c618e

Use a dedicated safe callback for call_soon detaches and keep ValueError suppression behavior for invalid/non-current tokens without regressing deferred-detach tracing fix. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Simplify deferred detach path

748d9f3

Use call_soon(detach_context, token) directly and keep ValueError handling in detach_context to avoid callback noise while preserving deferred trace context behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Detach deferred OTel token safely

836b042

Use an explicit deferred callback helper that detaches the attached token and swallows ValueError to avoid unhandled callback noise while preserving delayed context cleanup. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

harsheet-shah requested a review from Copilot June 8, 2026 08:30

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py Outdated

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py Outdated

Harsheet Shah and others added 2 commits June 8, 2026 14:03

Add fallback when call_soon scheduling fails

04ec5af

Wrap deferred detach scheduling in try/except and fall back to immediate best-effort detach so token cleanup still happens when the event loop is closing/closed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Reuse detach_context for deferred cleanup

98419e4

Route both call_soon callback and scheduling-failure fallback through detach_context(token) to keep detach semantics centralized and consistent. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

harsheet-shah requested a review from Copilot June 8, 2026 08:36

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py Outdated

Comment thread sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py

Harsheet Shah and others added 2 commits June 8, 2026 14:29

Enrich logs with agent and session dimensions

3a8134a

Add agent name/version and sessionid dimensions to log records via OTel log processor while retaining baggage propagation and span enrichment. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Harsheet Shah and others added 4 commits June 8, 2026 15:47

Fix trace context detach and agent identity resolution

5243eb2

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add AZURE_AI_* agent identity fallback

c0e39a3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Revert agent name/version fallback changes

f2ab16b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Revert agent name/version enrichment changes

ab46ec2

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Conversation

harsheet-shah commented Jun 8, 2026

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

Uh oh!

github-actions Bot commented Jun 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

singankit Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

singankit Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

harsheet-shah Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants