.NET: expose OpenTelemetryAgent.DefaultSourceName

[Yashvant Mahadev Hange (YashvantHange)]

Motivation & Context

ADR 0003 documents how to subscribe to agent telemetry:

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource(AgentOpenTelemetryConsts.DefaultSourceName)
    .AddConsoleExporter()
    .Build();

That snippet does not compile against the shipped package. AgentOpenTelemetryConsts was renamed to OpenTelemetryConsts in #356, and the type is internal, so DefaultSourceName is unreachable from outside the assembly. Consumers who want to receive invoke_agent spans under the default source have to hardcode the literal "Experimental.Microsoft.Agents.AI", which fails silently if that name ever changes. The repository's own tests hardcode the same literal.

Description & Review Guide

• What are the major changes?

  OpenTelemetryAgent gains a public const string DefaultSourceName that forwards to the existing internal OpenTelemetryConsts.DefaultSourceName. The constant is placed on the type that emits the spans, so OpenTelemetryConsts and the gen_ai.* attribute keys remain internal, preserving the Microsoft.Extensions.AI symmetry that ADR 0003 lists as a design goal. The ADR usage snippet is corrected to reference the constant that now exists. A unit test pins the constant to the literal source name so a rename cannot silently break subscribers.

• What is the impact of these changes?

  Purely additive. Release builds of Microsoft.Agents.AI succeed across all five target frameworks with no warnings, and Package Validation reports no compatibility diagnostics against the published baseline. No existing behavior changes.

• What do you want reviewers to focus on?

  Whether OpenTelemetryAgent is the placement you want for the constant. Moving it is a one-line change if you would prefer it elsewhere. The narrower question of whether to also make the gen_ai.* attribute keys public is deliberately left out of this change, since it is a larger API commitment.

Related Issue

Fixes #6452

Contribution Checklist

• The code builds clean without any errors or warnings
• All unit tests pass, and I have added new tests where possible
• The PR follows the Contribution Guidelines
• This PR is linked to an issue and there is no other open PR for this issue (see Related Issue above).
• This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

[Copilot]

Pull request overview

Exposes the default OpenTelemetry activity source name for external subscribers and updates guidance and tests accordingly.

Changes:

• Adds OpenTelemetryAgent.DefaultSourceName.
• Updates the ADR usage example.
• Tests the exposed source name.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
dotnet/src/Microsoft.Agents.AI/OpenTelemetryAgent.cs	Exposes the default telemetry source name.
dotnet/tests/Microsoft.Agents.AI.UnitTests/OpenTelemetryAgentTests.cs	Verifies the exposed value.
docs/decisions/0003-agent-opentelemetry-instrumentation.md	Uses the public API in the example.

---

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

[Yashvant Mahadev Hange (YashvantHange)]

@microsoft-github-policy-service agree

[Roger Barreto (rogerbarreto)]

Thanks for the contribution, please also consider updating the wording in the ADR + XmlDocs as suggested, LGTM

[Yashvant Mahadev Hange (YashvantHange)]

Roger Barreto (@rogerbarreto) please re-review

[Yashvant Mahadev Hange (YashvantHange)]

Roger Barreto (@rogerbarreto) this got dequeued from the merge queue on 1 Sep rather than merged, and it needed a change from me to go back in — pushed as 3a72b50e6.

The queue build failed RS0016 five times, once per target framework:

error RS0016: Symbol '[MAAI001]static Microsoft.Agents.AI.OpenTelemetryAgent.DefaultSourceName.get -> string!'
is not part of the declared public API

Nothing was wrong with the change itself. #7935 added the public API analyzers on 31 Aug, after this branch's last CI run, so the branch built clean in isolation and only failed once the queue merged it with main. Any .NET PR whose last CI run predates that commit and adds public surface will hit the same thing.

Fixed by declaring the member in the Microsoft.Agents.AI baseline for all five target frameworks, in PublicAPI.Unshipped.txt rather than Shipped since it has not been released — the promotion workflow moves it across after a release. Also merged current main in, so the branch is no longer behind.

Could you re-approve and put it back in the queue when you get a chance?