Skip to content

[agentserver] Invoke and Core package refactor#46127

Open
ankitbko wants to merge 25 commits intomainfrom
agentserver/invoke
Open

[agentserver] Invoke and Core package refactor#46127
ankitbko wants to merge 25 commits intomainfrom
agentserver/invoke

Conversation

@ankitbko
Copy link
Copy Markdown
Member

@ankitbko ankitbko commented Apr 4, 2026

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.

Ankit Sinha and others added 5 commits April 4, 2026 03:40
Address pvaneck review comments from PR #45925
a8938f4 
- Added docstring for TracingHelper.__init__ connection_string param
- Added enrichment processor dupe guard (_enrichment_configured flag)
- Fixed InMemorySpanExporter import path in test_tracing.py
- Fixed @app → @server variable name mismatch in test_tracing.py
- Updated invocations CHANGELOG with 2.0.0b1 + kept 1.0.0b1 history
- Fixed duplicate InvocationAgentServerHost imports in README
- Fixed README titles to match Verify Readmes pattern
- Fixed tracing tests to use TestClient and set APPLICATIONINSIGHTS env var
- Fixed test pollution: OTel provider reused across test modules
- Removed obsolete baggage test

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix CHANGELOGs: add 1.0.0b1 history to core, keep invocations at 1.0.0b1
4b41b22 
Core: added historical 1.0.0b1 entry below 2.0.0b1, removed stale
leaf_customer_span_id from features.

Invocations: reverted to single 1.0.0b1 entry (new package, no prior
releases). Updated feature list to reflect InvocationAgentServerHost.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Refactor TracingHelper class → module functions + host method
e08455a 
Replaced the TracingHelper class with:
- configure_tracing() — standalone function for exporter setup,
  overridable via AgentServerHost(configure_tracing=my_func) or
  disabled with configure_tracing=None
- request_span() — module-level context manager for span creation
- end_span/record_error/trace_stream — module-level lifecycle helpers
- AgentServerHost.request_span() — thin method that delegates with
  pre-populated host identity (agent_id, project_id)

Protocol SDKs now use self.request_span() instead of
self._tracing.request_span() with None checks. All functions are
no-ops when opentelemetry-api is not installed.

Removed TracingHelper from core __init__.py exports.
Agent identity (name/version/project_id) moved to AgentServerHost.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update core sample to use new tracing API (self.request_span)
f98a107 
Removed TracingHelper import, contextlib.nullcontext pattern, and
None checks. Now uses self.request_span() and _tracing.record_error().

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove get_logger() — use logging.getLogger directly
79e08a1 
get_logger() was a one-liner wrapping logging.getLogger('azure.ai.agentserver').
Replaced all usages with direct logging.getLogger() calls and deleted _logger.py.
Removed get_logger from core __init__.py exports.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko ankitbko requested a review from JC-386 as a code owner April 4, 2026 15:13
Copilot AI review requested due to automatic review settings April 4, 2026 15:13
@ankitbko ankitbko requested a review from lusu-msft as a code owner April 4, 2026 15:13
@github-actions github-actions bot added the Hosted Agents sdk/agentserver/* label Apr 4, 2026
Copilot AI reviewed Apr 4, 2026
View reviewed changes
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 refactors the AgentServer tracing and logging surface, moving from class-based helpers to function-based tracing setup and host-provided span helpers, and updates the invocations protocol and tests accordingly.

Changes:

  • Refactor core tracing from TracingHelper to function-based APIs (configure_tracing, request_span, end_span, record_error, trace_stream) and add AgentServerHost.request_span().
  • Update invocations host and tests to use the new tracing APIs and switch tests from httpx ASGI transport to starlette.testclient.TestClient.
  • Refresh READMEs/CHANGELOGs to align with the invocations host model and updated tracing behavior.

Reviewed changes

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

Show a summary per file
File Description
sdk/agentserver/azure-ai-agentserver-invocations/tests/test_tracing.py Updates tracing tests to new tracing implementation and TestClient usage.
sdk/agentserver/azure-ai-agentserver-invocations/tests/test_span_parenting.py Adjusts span parenting tests for the updated tracing/context behavior.
sdk/agentserver/azure-ai-agentserver-invocations/README.md Updates package title and removes duplicated imports in snippets.
sdk/agentserver/azure-ai-agentserver-invocations/CHANGELOG.md Updates feature list to reflect InvocationAgentServerHost and mixin model.
sdk/agentserver/azure-ai-agentserver-invocations/azure/ai/agentserver/invocations/_invocation.py Moves invocations tracing to host span helper + core tracing functions.
sdk/agentserver/azure-ai-agentserver-core/tests/test_tracing.py Updates tests to validate configure_tracing injection behavior.
sdk/agentserver/azure-ai-agentserver-core/samples/selfhosted_invocation/selfhosted_invocation.py Updates sample to use AgentServerHost.request_span() and new tracing helpers.
sdk/agentserver/azure-ai-agentserver-core/README.md Updates package title.
sdk/agentserver/azure-ai-agentserver-core/CHANGELOG.md Updates breaking-change notes for tracing/logging behavior.
sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_tracing.py Implements the function-based tracing API and exporter setup.
sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_logger.py Removes the old get_logger() facade module.
sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/_base.py Adds configure_tracing injection + request_span() convenience method.
sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver/core/init.py Updates exported public API surface.

Ankit Sinha and others added 7 commits April 4, 2026 15:55
Make OTel a primary dependency, remove _HAS_OTEL guard
93e2fc6 
Moved opentelemetry-api, opentelemetry-sdk, opentelemetry-exporter-otlp,
and azure-monitor-opentelemetry-exporter from optional [tracing] extras
to primary dependencies. Removed _HAS_OTEL flag, try/except import
guard, and all conditional checks — OTel is always available.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko
Update sdk/agentserver/azure-ai-agentserver-invocations/tests/test_tr…
3d10d8d 
…acing.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ankitbko
Update sdk/agentserver/azure-ai-agentserver-invocations/tests/test_tr…
c8672e4 
…acing.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ankitbko
Update sdk/agentserver/azure-ai-agentserver-core/azure/ai/agentserver…
dc373bc 
…/core/_tracing.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
removed redundant packages
3dc7d03
Address PR review: expose tracing functions publicly, fix imports, up…
3709bfc 
…date CHANGELOG

- Exported end_span, record_error, trace_stream from core __init__.py
  (no more importing internal _tracing module from other packages)
- Updated invocations to use public imports from core
- Updated selfhosted sample to use public record_error import
- Added None guard in _wrap_streaming_response for otel_span
- Fixed test docstring mismatch (tracing_disabled_by_default)
- Updated CHANGELOG to reflect TracingHelper → functions change
- Fixed get_logger import in githubcopilot adapter

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Merge branch 'agentserver/invoke' of https://github.com/Azure/azure-s…
1c24a6a 
…dk-for-python into agentserver/invoke
Ankit Sinha and others added 2 commits April 4, 2026 20:12
Spec compliance: platform header, tracer scope, error attrs, baggage,…
08add53 
… isolation headers, HTTP/2

- x-platform-server header now includes version and python runtime
- Instrumentation scope: Azure.AI.AgentServer (core), .Invocations (invocations)
- record_error() now sets error.type attribute per OTel semantic conventions
- baggage header included in W3C trace context extraction
- x-request-id propagated into span attributes
- Platform isolation headers (x-agent-user-isolation-key, x-agent-chat-isolation-key) exposed via request.state
- HTTP/2 disabled in Hypercorn config (spec requires HTTP/1.1 only)
- Fixed get_logger import in githubcopilot adapter

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Spec compliance: baggage keys, SSE keep-alive, structured logging, SI…
15a2f21 
…GTERM forwarding

- Re-added W3C baggage propagation for invocation_id/session_id
- Added SSE_KEEPALIVE_INTERVAL env var and resolve_sse_keepalive_interval()
- Added sse_keepalive_stream() as AgentServerHost static method (not in tracing)
- Added _InvocationLogFilter for structured log scope with InvocationId/SessionId
- Added SIGTERM handler in run() that logs and re-raises for Hypercorn
- Separated trace_stream (tracing concern) from sse_keepalive_stream (transport)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko ankitbko requested a review from Copilot April 5, 2026 01:32
Copilot AI reviewed Apr 5, 2026
View reviewed changes
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 125 out of 131 changed files in this pull request and generated 5 comments.

Ankit Sinha and others added 2 commits April 5, 2026 05:54
Fix PR review: contextvars for logging, SIGTERM restore, deduplicate …
680f6a0 
…log handler

- Replaced per-request logger.addFilter/removeFilter with contextvars
  (_invocation_id_var, _session_id_var) for concurrency-safe structured
  logging. Filter installed once at module level, reads from contextvars.
- SIGTERM handler now restored in finally block after run() exits.
- _setup_otlp_log_export only adds LoggingHandler when Azure Monitor
  handler is not already configured, preventing duplicate log emission.
- Fixed Black formatting in test_tracing.py dict literals.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Move azure-monitor-opentelemetry-exporter to optional dep
973a32b 
The CI dev-build tool (process_requires) rewrites all azure-* dependency
version specs for dev builds, transforming >=1.0.0b21 into >=1.0.0a1,<1.0.0b0
which is unresolvable. The exporter is imported lazily with try/except
in _tracing.py so it works correctly when installed separately.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko ankitbko requested a review from Copilot April 5, 2026 06:54
Copilot AI reviewed Apr 5, 2026
View reviewed changes
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 125 out of 131 changed files in this pull request and generated 3 comments.

Add azure-monitor-opentelemetry-exporter to CI Artifacts
15aa0c5 
The CI dev-build tool (process_requires) rewrites azure-* dependency
version specs. Adding the exporter to Artifacts ensures a compatible
dev build is published to the dev feed alongside agentserver packages.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Ankit Sinha and others added 2 commits April 5, 2026 07:16
Fix PR comments: log filter comment, tracing docstring, changelog bag…
cc02fb9 
…gage

- Updated _ensure_log_filter comment to say 'first request' not 'module load'
- Updated _tracing.py docstring: OTel is required, not optional
- Added W3C Baggage and structured logging to invocations CHANGELOG

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Revert "Add azure-monitor-opentelemetry-exporter to CI Artifacts"
6f6cc45 
This reverts commit 15aa0c5.
@ankitbko ankitbko requested a review from Copilot April 5, 2026 08:14
Copilot AI reviewed Apr 5, 2026
View reviewed changes
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 125 out of 131 changed files in this pull request and generated 5 comments.

Fix PR comments: keepalive shield, SIGTERM comment, docstring, thread…
7fb8b8e 
…-safe filter

- sse_keepalive_stream: use asyncio.shield to prevent cancelling upstream
  iterator on timeout. Reuse pending task across timeouts.
- SIGTERM handler comment: clarified it logs and re-raises, not forwards.
- request_span docstring: removed stale 'no-op when OTel not installed'.
- _ensure_log_filter: added threading.Lock for double-checked locking.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko ankitbko requested a review from Copilot April 5, 2026 08:28
Copilot AI reviewed Apr 5, 2026
View reviewed changes
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 125 out of 131 changed files in this pull request and generated 3 comments.

Fix: duplicate imports, sanitize IDs in get/cancel endpoints, copilot…
4fa8ee7 
… adapter logging

- Removed duplicate 'import logging' in _invocation.py
- Added _sanitize_id for invocation_id and session_id in _traced_invocation_endpoint
- Fixed _copilot_adapter.py: consolidated logging import, removed _logging alias

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@ankitbko ankitbko requested review from Copilot April 5, 2026 08:59
Copilot AI reviewed Apr 5, 2026
View reviewed changes
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 125 out of 131 changed files in this pull request and generated 3 comments.

Ankit Sinha and others added 3 commits April 5, 2026 12:30
Spec compliance: baggage propagator, x-request-id baggage, baggage-to…
b80e734 
…-log processor

- Replaced TraceContextTextMapPropagator with CompositePropagator
  (TraceContextTextMapPropagator + W3CBaggagePropagator) to properly
  extract inbound baggage header into OTel context.
- x-request-id now set as both span attribute AND baggage entry for
  downstream propagation.
- Added _BaggageLogRecordProcessor that copies all W3C Baggage entries
  into every OTel log record's attributes for end-to-end correlation.
  Registered on both Azure Monitor and OTLP log providers.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix import ordering: stdlib → third-party → local per ruff/isort
5fea569 
- _base.py: moved 'import sys' to stdlib group
- _tracing.py: moved opentelemetry imports to third-party group before constants
- _invocation.py: moved contextvars to stdlib group, opentelemetry to third-party, removed duplicate import

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix _BaggageLogRecordProcessor: rename emit → on_emit per OTel SDK API
8fa57a6 
The OTel SDK's LogRecordProcessor interface requires on_emit(),
not emit(). This caused AttributeError when the log handler tried
to process log records through the processor chain.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JC-386 JC-386 Awaiting requested review from JC-386 JC-386 is a code owner

@lusu-msft lusu-msft Awaiting requested review from lusu-msft lusu-msft is a code owner

@jodeklotzms jodeklotzms Awaiting requested review from jodeklotzms jodeklotzms is a code owner

@pradeepkintali pradeepkintali Awaiting requested review from pradeepkintali pradeepkintali is a code owner

@tendau tendau Awaiting requested review from tendau tendau is a code owner

@ganeshyb ganeshyb Awaiting requested review from ganeshyb ganeshyb is a code owner

@code-vicar code-vicar Awaiting requested review from code-vicar code-vicar is a code owner

@msyyc msyyc Awaiting requested review from msyyc

@lmazuel lmazuel Awaiting requested review from lmazuel

@scbedd scbedd Awaiting requested review from scbedd

Copilot code review Copilot Awaiting requested review from Copilot

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

Hosted Agents sdk/agentserver/*

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ankitbko