-
Notifications
You must be signed in to change notification settings - Fork 6.1k
[DiagnosticsClient] Update APIs #50376
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
[DiagnosticsClient] Update APIs #50376
Conversation
There was a problem hiding this 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
SupportsEventPipeUserEventsCommandmethods 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.
|
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 |
While adding documentation for theSupportsEventPipeUserEventsCommandAPIs (dotnet/diagnostics#5656), I figured I should update all public APIs fromMicrosoft.Diagnostics.NETCore.Client'sDiagnosticsClientclass.The intent is to merge this PR after the next Microsoft.Diagnostics.NETCore.Client release containing theSupportsEventPipeUserEventsCommandAPIs.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