Skip to content

Commit d5cf8ce

Browse files
committed
[DiagnosticsClient] Add SupportsEventPipeUserEventsCommand APIs
1 parent f3a1a39 commit d5cf8ce

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/core/diagnostics/microsoft-diagnostics-netcore-client.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ public sealed class DiagnosticsClient
4747
EventPipeSessionConfiguration configuration,
4848
CancellationToken token);
4949

50+
public bool SupportsEventPipeUserEventsCommand();
51+
52+
public Task<bool> SupportsEventPipeUserEventsCommandAsync(
53+
CancellationToken token = default);
54+
5055
public void WriteDump(
5156
DumpType dumpType,
5257
string dumpPath,
@@ -169,6 +174,19 @@ Starts an EventPipe tracing session using an [`EventPipeSessionConfiguration`](#
169174
* `config` / `configuration` : An `EventPipeSessionConfiguration` that defines the session.
170175
* `token` (for the async overload): The token to monitor for cancellation requests.
171176

177+
### SupportsEventPipeUserEventsCommand methods
178+
179+
```csharp
180+
public bool SupportsEventPipeUserEventsCommand();
181+
182+
public Task<bool> SupportsEventPipeUserEventsCommandAsync(
183+
CancellationToken token = default);
184+
```
185+
186+
Checks whether the target runtime understands the `CollectTracing5` `user_events` IPC command.
187+
188+
* `token` (for the async overload): The token to monitor for cancellation requests.
189+
172190
> [!NOTE]
173191
> Rundown events contain payloads that may be needed for post analysis, such as resolving method names of thread samples. Unless you know you do not want this, we recommend setting `requestRundown` to true. In large applications, this may take a while.
174192

0 commit comments

Comments
 (0)