Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Document that AddOpenTelemetryProvider does not register default instrumentation or exporters by Evangelink · Pull Request #8930 · microsoft/testfx · GitHub
Skip to content

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters - #8930

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation
Jun 9, 2026
Merged

Document that AddOpenTelemetryProvider does not register default instrumentation or exporters#8930
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
Evangelink:dev/amauryleve/fix-otel-default-instrumentation

Conversation

@Evangelink

@EvangelinkAmaury Levé (Evangelink) commented Jun 8, 2026

Copy link
Copy Markdown
Member

Fixes#8409.

Problem

AddOpenTelemetryProvider documented that omitting withTracing / withMetrics would use "default OpenTelemetry settings", but it actually built empty TracerProvider / MeterProvider instances. The PACKAGE.md claim that the extension "instruments test execution with OpenTelemetry-compatible traces and metrics" was therefore not true for the zero-configuration path — builder.AddOpenTelemetryProvider(); produced no MTP telemetry.

Approach

Per the issue, option #2: keep runtime behavior under the caller's control and make the API contract honest. Auto-registering MTP instrumentation inside the provider was considered but rejected to preserve the (real, if niche) scenario of using this extension purely to manage the lifecycle of an OTel pipeline for application-only telemetry; the caller still needs a Program.cs to wire exporters either way, so the convenience gain was small.

  • OpenTelemetryProviderExtensions.cs: XML docs on AddOpenTelemetryProvider now state explicitly that no instrumentation or exporter is registered by default and that the caller must wire both via the delegates, including AddTestingPlatformInstrumentation() to subscribe to MTP. AddTestingPlatformInstrumentation docs describe both use sites (inside the delegates and on a TracerProviderBuilder / MeterProviderBuilder configured outside the helper).
  • PACKAGE.md: drops the misleading "instruments test execution" framing and spells out the wiring required to actually collect MTP telemetry.
  • samples/public/MTPOTel/Program.cs: adds a short comment summarising the contract.

No public API surface change, no runtime behavior change — docs and sample only.

Verification

Built the extension cleanly (Debug, all TFMs) — 0 warnings, 0 errors.

CopilotAI review requested due to automatic review settings June 8, 2026 13:41

CopilotAI 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 fixes the zero-configuration behavior of the Microsoft.Testing.Platform (MTP) OpenTelemetry extension by ensuring MTP’s ActivitySource and Meter are automatically registered when AddOpenTelemetryProvider() is used, bringing runtime behavior in line with the documented contract (Fixes #8409).

Changes:

  • Auto-registers MTP tracing/metrics instrumentation (Microsoft.Testing.Platform) inside OpenTelemetryProvider prior to invoking user configuration delegates.
  • Updates XML docs and package documentation to clarify the new contract (instrumentation auto-wired; exporters still caller-configured).
  • Simplifies the public sample by removing redundant AddTestingPlatformInstrumentation() calls.
Show a summary per file
FileDescription
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProvider.csAdds .AddSource(...) and .AddMeter(...) by default so zero-config calls actually instrument MTP telemetry.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/OpenTelemetryProviderExtensions.csUpdates XML docs to reflect auto-wiring and clarify what callers still must configure.
src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.mdUpdates package docs to describe exporter responsibility and the zero-config behavior more accurately.
samples/public/MTPOTel/Program.csRemoves redundant instrumentation calls to demonstrate the simplified API surface.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 2

Comment threadsrc/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md Outdated
…TelemetryProvider
Fixesmicrosoft#8409.
`AddOpenTelemetryProvider` documented that omitting the delegates would use
"default OpenTelemetry settings", but in practice it built empty `TracerProvider`
/ `MeterProvider` instances and the package README claimed it instruments
test execution out of the box - neither of which matches reality.
Rather than auto-registering MTP sources (which would also prevent callers
from hosting an OTel pipeline through this extension for app-only telemetry),
this change keeps full control in the caller's hands and makes the API
contract honest:
- XML docs on `AddOpenTelemetryProvider` now state explicitly that no
instrumentation or exporter is registered by default, and that the caller
must wire both via the `withTracing` / `withMetrics` delegates.
- `AddTestingPlatformInstrumentation` docs describe both use sites (from
inside the delegates and from a builder configured outside the helper).
- PACKAGE.md drops the misleading "instruments test execution" wording and
spells out the wiring required to actually collect MTP telemetry.
- The MTPOTel sample gets a comment summarising the contract.
No public API surface change, no runtime behavior change.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Evangelink
Amaury Levé (Evangelink)force-pushed the dev/amauryleve/fix-otel-default-instrumentation branch from 7630129 to 59104d9CompareJune 8, 2026 13:52
@EvangelinkAmaury Levé (Evangelink) changed the title Auto-register MTP instrumentation in AddOpenTelemetryProviderDocument required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderJun 8, 2026
@Evangelink

Copy link
Copy Markdown
MemberAuthor

Filed #8931 to track the Roslyn analyzer follow-up (warn when Microsoft.Testing.Extensions.OpenTelemetry is referenced but AddOpenTelemetryProvider is never invoked). Keeping this PR scoped to the docs/contract fix per the discussion.

@EvangelinkAmaury Levé (Evangelink) changed the title Document required MTP instrumentation and exporter wiring for AddOpenTelemetryProviderDocument that AddOpenTelemetryProvider does not register default instrumentation or exportersJun 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 15041b8 into microsoft:mainJun 9, 2026
28 checks passed
@Evangelink
Amaury Levé (Evangelink) deleted the dev/amauryleve/fix-otel-default-instrumentation branch June 9, 2026 07:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MTP Diagnostic Analysis] AddOpenTelemetryProvider defaults to a no-op despite documented default behavior

2 participants

@Evangelink