Skip to content

Conversation

@mdh1418
Copy link
Member

@mdh1418mdh1418 commented Dec 7, 2025

While adding documentation for the SupportsEventPipeUserEventsCommand APIs (dotnet/diagnostics#5656), I figured I should update all public APIs from Microsoft.Diagnostics.NETCore.Client's DiagnosticsClient class.

The intent is to merge this PR after the next Microsoft.Diagnostics.NETCore.Client release containing the SupportsEventPipeUserEventsCommand APIs.

Update: The plan is to keep SupportsEventPipeUserEventsCommand as an internal API utilized by dotnet-trace collect-linux. So this PR now just updates the documented public APIs.


Internal previews

📄 File🔗 Preview link
docs/core/diagnostics/microsoft-diagnostics-netcore-client.mdMicrosoft.Diagnostics.NETCore.Client API

CopilotAI review requested due to automatic review settings December 7, 2025 20:04
@mdh1418mdh1418 requested a review from a team as a code ownerDecember 7, 2025 20:04
@dotnetrepomandotnetrepomanbot added this to the December 2025 milestone Dec 7, 2025
Copy link
Contributor

CopilotAI left a comment

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 API documentation for the Microsoft.Diagnostics.NETCore.Client library, adding documentation for the new SupportsEventPipeUserEventsCommand APIs and comprehensively updating all public APIs from the DiagnosticsClient class.

Key changes:

  • Documents new SupportsEventPipeUserEventsCommand methods for checking runtime IPC command support
  • Adds documentation for previously undocumented API overloads (EventPipeSession, WriteDump, ApplyStartupHook, and PerfMap methods)
  • Introduces documentation for new classes (EventPipeSessionConfiguration, DiagnosticsClientConnector) and enums (WriteDumpFlags, PerfMapType, ProfilerAlreadyActiveException)

This reverts commit d5cf8ce. It will start off as an internal API utilized by dotnet-trace.
@mdh1418
Copy link
MemberAuthor

It looks like the OpenPublishing.Build warning is an unrelated file not changed in this pr, and the instructions link to resolve it is broken. The unrelated file is docs/standard/commandline/migration-guide-2.0.0-beta5.md | Warning | View | gewarren | dotnet-fundamentals | | Line 64: [Warning] Cross reference not found: 'System.CommandLine.Option.Name'.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mdh1418