Make DiagnosticsClient.StartEventPipeSessionAsync public #4394
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows user code to pass a cancellation token without wrapping the call to StartEventPipeSession() in Task.Run() or similar. Resolves dotnet#3727.
emz00
commented
Nov 13, 2023
| /// </returns> | ||
| internal Task<EventPipeSession> StartEventPipeSessionAsync(IEnumerable<EventPipeProvider> providers, bool requestRundown, int circularBufferMB, CancellationToken token) | ||
| public Task<EventPipeSession> StartEventPipeSessionAsync(IEnumerable<EventPipeProvider> providers, bool requestRundown, | ||
| int circularBufferMB = DefaultCircularBufferMB, CancellationToken token = default) |
Contributor
Author
There was a problem hiding this comment.
Made circularBufferMB optional here consistent with the sync overload and extracted the default value into a constant to avoid duplicating it. This required making token optional as well.
Member
Member
mikelle-rogers
left a comment
There was a problem hiding this comment.
@loop-evgeny, will you please document this now that it is public?
It can be documented here: https://github.com/dotnet/docs/blob/main/docs/core/diagnostics/microsoft-diagnostics-netcore-client.md
emz00
added a commit
to emz00/dotnet-docs
that referenced
this pull request
Nov 17, 2023
These are being made public in dotnet/diagnostics#4394
emz00
added a commit
to emz00/dotnet-docs
that referenced
this pull request
Nov 17, 2023
These are being made public in dotnet/diagnostics#4394
Contributor
Author
davmason
approved these changes
Nov 21, 2023
gewarren
pushed a commit
to dotnet/docs
that referenced
this pull request
Nov 27, 2023
* Document DiagnosticsClient.StartEventPipeSessionAsync methods These are being made public in dotnet/diagnostics#4394 * Update docs/core/diagnostics/microsoft-diagnostics-netcore-client.md Co-authored-by: mikelle-rogers <45022607+mikelle-rogers@users.noreply.github.com> * Add StartEventPipeSessionAsync to method summary list --------- Co-authored-by: mikelle-rogers <45022607+mikelle-rogers@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows user code to pass a cancellation token without wrapping the call to StartEventPipeSession() in Task.Run() or similar. Resolves #3727.