Skip to content

.NET: Update OpenTelemetry Agent - Added Demo, AIAgentMetadata and Agent.GetService() - #356

Merged
Roger Barreto (rogerbarreto) merged 28 commits into
microsoft:mainfrom
rogerbarreto:demos/open-telemetry-agent
Aug 15, 2025
Merged

.NET: Update OpenTelemetry Agent - Added Demo, AIAgentMetadata and Agent.GetService() #356
Roger Barreto (rogerbarreto) merged 28 commits into
microsoft:mainfrom
rogerbarreto:demos/open-telemetry-agent

Conversation

@rogerbarreto

@rogerbarreto Roger Barreto (rogerbarreto) commented Aug 6, 2025

Copy link
Copy Markdown
Member

Motivation and Context

This is a second round on the Agent OpenTelemetry implementation expanding the support and behavior of the current implementation.

  • Added Demo Sample using Open Telemetry with Aspire Dashboard
  • To be able to retrieve required OTEL information for the genai.system, there was no option in agents to identify the system and as part of this current limitation I did introduce AIAgentMetadata and Agent.GetService() similar manner as found in MEAI's IChatClient to retrieve Agent specific metadata for OTEL and potentially more usages.
  • Added Loging support for OpenTelemetryAgent with proper duplication prevention (if the agent has a chatclient with OTEL already enabled and logging)
  • Small restructure of Solution folders (Samples/Demos/src/Tests).

Copilot AI review requested due to automatic review settings August 6, 2025 14:17
@eavanvalkenburg Eduard van Valkenburg (eavanvalkenburg) added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net labels Aug 6, 2025
@github-actions github-actions Bot changed the title .Net: Update OpenTelemetry Agent - Added Demo, AIAgentMetadata and Agent.GetService() .NET: Update OpenTelemetry Agent - Added Demo, AIAgentMetadata and Agent.GetService() Aug 6, 2025
Copilot AI reviewed Aug 6, 2025
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 updates the OpenTelemetry Agent implementation with expanded support and behavior, including a new demo sample, AIAgentMetadata for agent-specific metadata retrieval, and Agent.GetService() method similar to MEAI's IChatClient. The update also adds logging support with deduplication prevention and reorganizes solution folders.

  • Added comprehensive OpenTelemetry Agent demo with Aspire Dashboard integration
  • Introduced AIAgentMetadata and Agent.GetService() method for retrieving agent metadata and services
  • Enhanced OpenTelemetry logging with deduplication logic when agents already have OTEL-enabled chat clients

Reviewed Changes

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

Show a summary per file
File Description
OpenTelemetryAgent.cs Enhanced with logging support, metadata handling, and deduplication logic
OpenTelemetryConsts.cs New constants file replacing AgentOpenTelemetryConsts with updated naming
AIAgent.cs Added abstract GetService method and generic helper
AIAgentMetadata.cs New metadata class for agent provider information
ChatClientAgent.cs Implemented GetService method with metadata support
AgentOpenTelemetry demo Complete demo application with Aspire Dashboard integration
Test files Updated to use new constants and test new GetService functionality
Comments suppressed due to low confidence (1)

Comment thread dotnet/demos/AgentOpenTelemetry/Program.cs Outdated
Comment thread dotnet/demos/AgentOpenTelemetry/Program.cs
Comment thread dotnet/src/Microsoft.Extensions.AI.Agents/OpenTelemetryAgent.cs
Comment thread dotnet/demos/AgentOpenTelemetry/README.md Outdated
dmytrostruk
Dmytro Struk (dmytrostruk) approved these changes Aug 15, 2025
View reviewed changes
Comment thread dotnet/demos/AgentOpenTelemetry/README.md
Comment thread dotnet/src/Microsoft.Extensions.AI.Agents/OpenTelemetryAgent.cs Outdated
@rogerbarreto
Roger Barreto (rogerbarreto) added this pull request to the merge queue Aug 15, 2025
Merged via the queue into microsoft:main with commit 5311320 Aug 15, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in Agent Framework Aug 15, 2025
@DeagleGross Korolev Dmitry (DeagleGross) mentioned this pull request Aug 19, 2025
Closed
4 tasks
Reuben Bond (ReubenBond) pushed a commit to ReubenBond/agent-framework that referenced this pull request Oct 28, 2025
@rogerbarreto
.NET: Update OpenTelemetry Agent - Added Demo, AIAgentMetadata and Ag…
cf6520d 
…ent.GetService() (microsoft#356)

* OTEL Demo

* updating telemetry sample

* OTEL updates

* WIP

* Adding GetService and Agent Metadata for Telemetry

* WIP

* Add UT for OTEL System behavior

* Address Unicode problem

* Add logging

* Adjust for new extensions

* Change Logger to LoggerFactory for the extension method

* Address AI Feedback

* Simplify script and readme just for Azure OpenAI

* Increase code converage

* Address merge conflict

* Another slnx fix

* Address PR comments

* Address PR feedback + Add UT

* Added Hosting UT to the solution

* Address PR comments

* Address missing sensitivity tests

* Remove unecessary override

* Address PR comments
@challaravinath Challa Ravi (challaravinath) mentioned this pull request Jun 12, 2026
Closed
Merged
5 tasks
leilei3167 pushed a commit to leilei3167/agent-framework that referenced this pull request Sep 14, 2026
@YashvantHange @rogerbarreto
.NET: expose OpenTelemetryAgent.DefaultSourceName (microsoft#7815)
7a82595 
* .NET: expose OpenTelemetryAgent.DefaultSourceName

The default ActivitySource name lives on the internal OpenTelemetryConsts
class, so consumers cannot reference it when configuring a TracerProvider
and must hardcode the literal "Experimental.Microsoft.Agents.AI" instead.
ADR 0003 documents AgentOpenTelemetryConsts.DefaultSourceName for this,
a type that no longer exists after the rename in microsoft#356.

Expose the source name as a public const on OpenTelemetryAgent, the type
that emits the spans, rather than making the whole constants class public.
That keeps the gen_ai.* attribute keys internal, matching the
Microsoft.Extensions.AI precedent, while making the documented AddSource
call compile. Update the ADR snippet to the constant that now exists.

* .NET: read DefaultSourceName at run time instead of inlining it

A public const is baked into each consumer assembly at compile time, so a
consumer built against one package version would keep subscribing to the
old literal after upgrading to a version that changed the source name, and
would silently stop receiving spans. That is the exact failure this API is
meant to remove, so expose the value as a static property that is read at
run time.

Rename the test to describe what it actually asserts and point at the
test that verifies emitted activities use the same source name.

* .NET: document that AddSource and the agent source name must match

The tracing pipeline only receives agent spans when the name registered
with TracerProviderBuilder.AddSource matches the source name the agent
emits under; a mismatch fails silently. Spell that pairing out in the
sourceName XML docs on UseOpenTelemetry and the OpenTelemetryAgent
constructors, and in the ADR usage example, which now also shows the
custom-source case and uses the AsBuilder().UseOpenTelemetry() API that
actually exists.

* .NET: mark OpenTelemetryAgent.DefaultSourceName experimental

DefaultSourceName is a new public API, so gate it behind MAAI001 and
graduate it later if it proves useful. The ADR usage section notes that
the diagnostic has to be suppressed to use the property.

* .NET: declare DefaultSourceName in the public API baseline

The public API analyzers added in microsoft#7935 require every public member of a
released package to be listed in that package's PublicAPI baseline for each
target framework. DefaultSourceName was added before those analyzers landed,
so this branch built clean on its own but failed RS0016 once merged with main.

Add the entry to all five Microsoft.Agents.AI baselines. Unshipped rather than
Shipped, since the member has not been released yet; the promotion workflow
moves it across after a release.

---------

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

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Balanced
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@dmytrostruk Dmytro Struk (dmytrostruk) dmytrostruk approved these changes
@westey-m westey (westey-m) westey-m approved these changes

Assignees

@rogerbarreto Roger Barreto (rogerbarreto)

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net

Projects

Agent Framework
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rogerbarreto @dmytrostruk @westey-m @eavanvalkenburg