Refactor of SK Sample to add more OTEL and Refactor for behavior of Teams / Messaging

[MattB-msft]

This pull request introduces a new shared library, AspireOTelServiceDefaults, to provide standardized OpenTelemetry, health check, and service discovery configuration for .NET Aspire-based agents. It also adds observability instrumentation to the sample agent, improves agent construction and initialization, and updates the solution structure for better modularity and maintainability.

Key changes:

1. Observability and Telemetry Enhancements

• Added the new AspireOTelServiceDefaults project, which provides extension methods to easily configure OpenTelemetry, health checks, service discovery, and HTTP client resilience for .NET Aspire agents. This includes sample configuration for metrics, tracing, and exporters, with detailed enrichment and filtering for telemetry data. (AspireOTelServiceDefaults/AgentOTELExtensions.cs, AspireOTelServiceDefaults.csproj) [1] [2]
• Implemented a new AgentMetrics class in the sample agent to expose custom metrics, counters, and histograms for message processing, route execution, and conversation tracking, along with helper methods for activity lifecycle management. (sample-agent/AgentMetrics.cs)

2. Agent Construction and Initialization Improvements

• Refactored Agent365Agent to support asynchronous initialization via a static factory method and an InitializeAgent365Agent async method, allowing more flexible dependency injection and configuration. (sample-agent/Agents/Agent365Agent.cs) [1] [2]
• Updated tool registration to use an async method for adding tool servers to the agent, improving scalability and correctness. (sample-agent/Agents/Agent365Agent.cs)

3. Solution and Dependency Management

• Added a solution-level nuget.config to support both public and local package sources for dependency resolution. (nuget.config)
• Updated the solution file to include the new AspireOTelServiceDefaults project and relevant configuration for Visual Studio. (SemanticKernelSampleAgent.sln)

4. Dependency and Usings Updates

• Updated various files to import new dependencies and namespaces required for OpenTelemetry, configuration, and async operations. (sample-agent/Agents/Agent365Agent.cs, sample-agent/MyAgent.cs) [1] [2]

These changes collectively improve the observability, modularity, and maintainability of the sample agent and provide a reusable pattern for other Aspire-based .NET agents to adopt best practices for telemetry and health monitoring.

[Copilot]

Pull Request Overview

This pull request introduces observability enhancements through OpenTelemetry integration and refactors agent initialization to support asynchronous patterns. The changes add a new shared library for standardized telemetry configuration and implement custom metrics/tracing throughout the sample agent.

Key changes:

• Added AspireOTelServiceDefaults library providing reusable OpenTelemetry, health checks, and service discovery configuration for .NET Aspire-based agents
• Implemented custom metrics and activity tracing in the sample agent through the new AgentMetrics class to track message processing, route execution, and conversation lifecycle
• Refactored Agent365Agent to use asynchronous initialization via a factory pattern and support streaming vs non-streaming response modes

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 24 comments.

Show a summary per file

File	Description
dotnet/AspireOTelServiceDefaults/AspireOTelServiceDefaults.csproj	New project file defining the shared OpenTelemetry library dependencies
dotnet/AspireOTelServiceDefaults/AgentOTELExtensions.cs	New extension methods for configuring OpenTelemetry, metrics, tracing, health checks, and service discovery
dotnet/semantic-kernel/sample-agent/AgentMetrics.cs	New metrics class providing counters, histograms, and activity management for observability
dotnet/semantic-kernel/sample-agent/Agents/Agent365Agent.cs	Refactored to support async initialization, factory pattern, and streaming/non-streaming response modes
dotnet/semantic-kernel/sample-agent/MyAgent.cs	Enhanced with observability instrumentation, refactored authentication resolution, and improved error handling
dotnet/semantic-kernel/sample-agent/Program.cs	Added OpenTelemetry configuration and enhanced message processing endpoint with metrics and tracing
dotnet/semantic-kernel/sample-agent/SemanticKernelSampleAgent.csproj	Updated package references and added project reference to AspireOTelServiceDefaults
dotnet/semantic-kernel/sample-agent/appsettings.json	Added OpenTelemetry configuration options and updated authentication scope
dotnet/semantic-kernel/sample-agent/ToolingManifest.json	Added new MCP server "mcp_MeServer" to tooling configuration
dotnet/semantic-kernel/sample-agent/Properties/launchSettings.json	Removed trailing comma in environment variables
dotnet/semantic-kernel/SemanticKernelSampleAgent.sln	Updated solution to include AspireOTelServiceDefaults project and nuget.config
dotnet/semantic-kernel/nuget.config	New solution-level NuGet configuration for package source management
dotnet/semantic-kernel/sample-agent/nuget.config	Removed project-level nuget.config (moved to solution level)
dotnet/semantic-kernel/sample-agent/SemanticKernelSampleAgent.sln	Removed (replaced by solution file at semantic-kernel level)
.gitignore	Added patterns to exclude transcript logs and Teams-related temporary files

Comments suppressed due to low confidence (2)

dotnet/semantic-kernel/sample-agent/Agents/Agent365Agent.cs:113

• Variable context may be null at this access because the parameter has a null default value.
  Variable context may be null at this access as suggested by this null check.
  Variable context may be null at this access as suggested by this null check.

        if (context.StreamingResponse.IsStreamingChannel)

dotnet/semantic-kernel/sample-agent/MyAgent.cs:283

• This assignment to response is useless, since its value is never read.

            Agent365AgentResponse response = await agent365Agent.InvokeAgentAsync(turnContext.Activity.Text, chatHistory , turnContext);