Open
Conversation
Co-authored-by: nikhilNava <211831449+nikhilNava@users.noreply.github.com>
…ndling in test Co-authored-by: nikhilNava <211831449+nikhilNava@users.noreply.github.com>
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
| mockActivity.Setup(a => a.ChannelId).Returns(new ChannelId("test-channel")); | ||
|
|
||
| mockTurnContext.Setup(tc => tc.Activity).Returns(mockActivity.Object); | ||
| mockTurnContext.Setup(tc => tc.StackState).Returns(new TurnContextStateCollection()); |
|
|
||
| // Read parent span lazily so the agent handler can set it during logic() | ||
| string? parentId = null; | ||
| if (turnContext.StackState.ContainsKey(A365ParentSpanKey)) |
Comment on lines
+136
to
+142
| foreach (var pair in pairs) | ||
| { | ||
| if (pair.Key == OpenTelemetryConstants.GenAiExecutionTypeKey) | ||
| { | ||
| return pair.Value?.ToString(); | ||
| } | ||
| } |
Comment on lines
+159
to
+166
| foreach (var a in activities) | ||
| { | ||
| if (string.Equals(a.Type, ActivityTypes.Message, StringComparison.OrdinalIgnoreCase) | ||
| && !string.IsNullOrEmpty(a.Text)) | ||
| { | ||
| messages.Add(a.Text); | ||
| } | ||
| } |
| parentId = turnContext.StackState[A365ParentSpanKey]?.ToString(); | ||
| } | ||
|
|
||
| var outputScope = OutputScope.Start( |
Copilot
AI
changed the title
[WIP] Implement baggage and output middleware
Add BaggageTurn and OutputLogging Bot Framework middleware
Mar 3, 2026
Dependency ReviewThe following issues were found:
License Issuessrc/Tests/Microsoft.Agents.A365.Observability.Hosting.Tests/Microsoft.Agents.A365.Observability.Hosting.Tests.csproj
OpenSSF Scorecard
Scanned Files
|
…ts and docs Co-authored-by: nikhilNava <211831449+nikhilNava@users.noreply.github.com>
Copilot
AI
changed the title
Add BaggageTurn and OutputLogging Bot Framework middleware
Add Bot Framework turn-level observability middleware with convenience registration
Mar 3, 2026
…d restore design.md Co-authored-by: nikhilNava <211831449+nikhilNava@users.noreply.github.com>
Copilot
AI
changed the title
Add Bot Framework turn-level observability middleware with convenience registration
Revert ObservabilityMiddlewareExtensions
Mar 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR appears to adjust the Observability Hosting surface area by adding Bot Framework middleware for OpenTelemetry baggage propagation and output span creation, along with corresponding unit tests and test dependencies.
Changes:
- Added
BaggageTurnMiddlewareto establish/dispose OpenTelemetry baggage per turn (skipping ContinueConversation events). - Added
OutputLoggingMiddlewareto createOutputScopespans for outgoing message activities and optionally link to a parent span. - Added/updated Hosting test project assets: new middleware unit tests and a
Moqpackage reference.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Observability/Hosting/Middleware/BaggageTurnMiddleware.cs | Adds Bot Framework middleware to set OpenTelemetry baggage derived from ITurnContext. |
| src/Observability/Hosting/Middleware/OutputLoggingMiddleware.cs | Adds Bot Framework middleware to create output tracing spans for sent message activities. |
| src/Tests/Microsoft.Agents.A365.Observability.Hosting.Tests/Middleware/BaggageTurnMiddlewareTests.cs | Adds unit tests covering baggage behavior and ContinueConversation skip behavior. |
| src/Tests/Microsoft.Agents.A365.Observability.Hosting.Tests/Middleware/OutputLoggingMiddlewareTests.cs | Adds unit tests verifying handler registration and pass-through behavior for missing context. |
| src/Tests/Microsoft.Agents.A365.Observability.Hosting.Tests/Microsoft.Agents.A365.Observability.Hosting.Tests.csproj | Adds Moq dependency needed by the new tests. |
Comment on lines
9
to
12
| <ItemGroup> | ||
| <PackageReference Include="FluentAssertions" /> | ||
| <PackageReference Include="Moq" /> | ||
| <PackageReference Include="coverlet.collector" /> |
There was a problem hiding this comment.
PR metadata says this change only reverts the UseObservabilityMiddleware extension and restores docs, but this PR also introduces new middleware (BaggageTurnMiddleware, OutputLoggingMiddleware) plus new tests and a new Moq dependency. Please update the PR title/description to reflect these additional additions, or split them into a separate PR so the revert can be reviewed/merged independently.
Comment on lines
+184
to
+204
| parentId: parentId); | ||
|
|
||
| try | ||
| { | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiConversationIdKey, conversationId); | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiExecutionTypeKey, executionType); | ||
|
|
||
| if (sourceMetadata != null) | ||
| { | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiChannelNameKey, sourceMetadata.Name); | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiChannelLinkKey, sourceMetadata.Description); | ||
| } | ||
|
|
||
| if (callerDetails != null) | ||
| { | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerIdKey, callerDetails.CallerId); | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerUpnKey, callerDetails.CallerUpn); | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerNameKey, callerDetails.CallerName); | ||
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerTenantIdKey, callerDetails.TenantId); | ||
| } | ||
|
|
There was a problem hiding this comment.
OutputScope.Start(...) (via OpenTelemetryScope) already accepts conversationId, sourceMetadata, and callerDetails and will apply the corresponding tags in one place. The current implementation passes those as null and then manually sets the same tags, which duplicates logic and risks drifting if tag behavior changes. Consider passing these values into OutputScope.Start and only setting tags here for values that aren’t covered by the scope constructor (e.g., execution type).
Suggested change
| parentId: parentId); | |
| try | |
| { | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiConversationIdKey, conversationId); | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiExecutionTypeKey, executionType); | |
| if (sourceMetadata != null) | |
| { | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiChannelNameKey, sourceMetadata.Name); | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiChannelLinkKey, sourceMetadata.Description); | |
| } | |
| if (callerDetails != null) | |
| { | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerIdKey, callerDetails.CallerId); | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerUpnKey, callerDetails.CallerUpn); | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerNameKey, callerDetails.CallerName); | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiCallerTenantIdKey, callerDetails.TenantId); | |
| } | |
| conversationId: conversationId, | |
| sourceMetadata: sourceMetadata, | |
| callerDetails: callerDetails, | |
| parentId: parentId); | |
| try | |
| { | |
| outputScope.SetTagMaybe(OpenTelemetryConstants.GenAiExecutionTypeKey, executionType); |
Comment on lines
+175
to
+177
| if (turnContext.StackState.ContainsKey(A365ParentSpanKey)) | ||
| { | ||
| parentId = turnContext.StackState[A365ParentSpanKey]?.ToString(); |
There was a problem hiding this comment.
Reading A365ParentSpanKey via ContainsKey(...) followed by the indexer performs two dictionary lookups and can race if the key is removed between calls. Prefer a single read (e.g., TryGetValue) and then ToString() on the retrieved value.
Suggested change
| if (turnContext.StackState.ContainsKey(A365ParentSpanKey)) | |
| { | |
| parentId = turnContext.StackState[A365ParentSpanKey]?.ToString(); | |
| if (turnContext.StackState.TryGetValue(A365ParentSpanKey, out var parentSpanValue) && parentSpanValue is not null) | |
| { | |
| parentId = parentSpanValue.ToString(); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reverts the
UseObservabilityMiddlewareIChannelAdapter extension added in the previous commit, per author request.ObservabilityMiddlewareExtensions.csand its test filedesign.mdto its prior stateWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
agent365.svc.cloud.microsoft/usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.deps.json /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/testhost.dll --port 46691 --endpoint 127.0.0.1:046691 --role client --parentprocessid 4310 --telemetryoptedin false(dns block)/usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.deps.json /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/testhost.dll --port 44183 --endpoint 127.0.0.1:044183 --role client --parentprocessid 4967 --telemetryoptedin false(dns block)override.example.com/usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.deps.json /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/testhost.dll --port 46691 --endpoint 127.0.0.1:046691 --role client --parentprocessid 4310 --telemetryoptedin false(dns block)/usr/share/dotnet/dotnet /usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/Microsoft.Agents.A365.Observability.Runtime.Tests.deps.json /home/REDACTED/work/Agent365-dotnet/Agent365-dotnet/src/Tests/Microsoft.Agents.A365.Observability.Runtime.Tests/bin/Debug/net8.0/testhost.dll --port 44183 --endpoint 127.0.0.1:044183 --role client --parentprocessid 4967 --telemetryoptedin false(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.