Skip to content

Document unreleased MTP telemetry items from main#54342

Draft
nohwnd wants to merge 3 commits into
dotnet:mainfrom
nohwnd:mtp-telemetry-main-items
Draft

Document unreleased MTP telemetry items from main#54342
nohwnd wants to merge 3 commits into
dotnet:mainfrom
nohwnd:mtp-telemetry-main-items

Conversation

@nohwnd

@nohwnd nohwnd commented Jun 10, 2026

Copy link
Copy Markdown
Member

Adds telemetry items seen in production telemetry CSV that are not documented in the table yet, and marks them as (main) because they are not tied to a released MTP version in Changelog-Platform.md.

This includes:

  • request/adapter/host timing data points
  • MSTest settings telemetry
  • MSTest usage payloads (attribute/assertion/custom method type usage)
  • reporter/graceful-exit signals

This is intentionally split from the versioned PR so released-version rows stay explicit.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 10, 2026 12:49

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 Microsoft.Testing.Platform (MTP) telemetry documentation to include additional telemetry data points observed in production telemetry output that aren’t yet represented in the article’s data point table, and marks those entries as coming from main (unreleased).

Changes:

  • Adds new timing-related telemetry data points (adapter loading, host builder/creation, and request/load phases).
  • Adds MSTest-related telemetry items (configuration/settings timeouts, configuration source, and usage payload summaries).
  • Adds a reporter/app “graceful exit” signal telemetry item.

Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated
Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated
Comment on lines +99 to +103
| (main) | Boolean for capturing debug traces. |
| (main) | Timeout in milliseconds for class cleanup. |
| (main) | Timeout in milliseconds for class initialization. |
| (main) | Boolean for treating empty data sources as inconclusive. |
| (main) | Boolean for enabling cooperative cancellation. |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

main is on purpose, this is ready for next release. Then it should be replaced with the actual version.

Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated
Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated

@Evangelink Evangelink left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cross-checked the additions against TelemetryProperties.cs and MSTestTelemetryDataCollector.cs. Direction is good and most rows map cleanly. A few corrections and a few missing rows inline.

Other small things:

  • ms.date (02/25/2026) wasn't bumped — worth updating before merge.
  • Style mismatch with existing rows (existing uses If … / short noun phrases; these use Boolean for … / Timestamp when …). The new style is more informative because it discloses the value type, so I am fine keeping it — just calling out for awareness.
  • Splitting versioned vs. unversioned into two PRs is a nice call.

Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated
Comment thread docs/core/testing/microsoft-testing-platform-telemetry.md Outdated
| (main) | Timeout in milliseconds for class cleanup. |
| (main) | Timeout in milliseconds for class initialization. |
| (main) | Boolean for treating empty data sources as inconclusive. |
| (main) | Boolean for enabling cooperative cancellation. |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor — mstest.setting.cooperative_cancellation is AsTelemetryBool(settings.CooperativeCancellationTimeout). It reports whether a cooperative-cancellation timeout was configured, not whether the feature is "enabled" per se. Consider tweaking to e.g. "Boolean indicating if a cooperative cancellation timeout was configured." Not blocking.

| (main) | Timeout in milliseconds for class initialization. |
| (main) | Boolean for treating empty data sources as inconclusive. |
| (main) | Boolean for enabling cooperative cancellation. |
| (main) | Source of MSTest configuration (runsettings or testconfig). |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source code comment for mstest.config_source lists three possible values, not two: "runsettings, testconfig.json, or none". Suggest tightening to enumerate all three and wrap literals in inline code to match prevailing table style:

Suggested change
| (main) | Source of MSTest configuration (runsettings or testconfig). |
| (main) | Source of MSTest configuration (`runsettings`, `testconfig.json`, or `none`). |

| (main) | Boolean for mapping inconclusive tests to failed. |
| (main) | Boolean for mapping non-runnable tests to failed. |
| (main) | Boolean for ordering tests alphabetically by name. |
| (main) | Boolean indicating if test parallelization is enabled. |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MSTestTelemetryDataCollector.AddSettingsMetrics also emits two parallelization items that aren''t documented in this PR — should be added alongside this row if the intent is parity with production telemetry CSV:

  • mstest.setting.parallelization_scope — string (MethodLevel / ClassLevel).
  • mstest.setting.parallelization_workers — number of parallel workers (only emitted when configured).

@nohwnd nohwnd marked this pull request as draft June 10, 2026 14:59
nohwnd and others added 2 commits June 10, 2026 16:06
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Amaury Levé <amauryleve@microsoft.com>
…ckticks

Changes:
- Update ms.date to 06/10/2026
- Convert remaining 'Boolean for/indicating if' to 'If' style for consistency
- Add backticks to config_source values (runsettings, testconfig.json, none)
- Fix cooperative_cancellation description to reflect timeout configuration
- Add missing custom_test_class_types row
- Add missing parallelization_scope and parallelization_workers rows

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to 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.

3 participants