-
Notifications
You must be signed in to change notification settings - Fork 6k
diagnostic: document waithandle keyword #40852
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
Changes from 4 commits
f131b03
14544d7
30cd953
b760c1d
ef43d93
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,3 +43,6 @@ | |
|
||
[Tiered compilation events](runtime-tiered-compilation-events.md)\ | ||
These events collect information about tiered compilation. | ||
|
||
[Wait handle events](runtime-wait-handle-events.md)\ | ||
These events collect information about wait handles. They help to diagnostic thread pool starvations. | ||
Check failure on line 48 in docs/fundamentals/diagnostics/runtime-events.md
|
||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: "Wait handle runtime events" | ||
description: See ETW events that collect information specific to the wait handles. | ||
ms.date: "05/27/2024" | ||
helpviewer_keywords: | ||
- "wait handle events (CoreCLR)" | ||
- "ETW, EventPipe, LTTng wait handle events (CoreCLR)" | ||
--- | ||
|
||
# .NET runtime wait handle events | ||
|
||
These runtime events capture information about wait handles. They can be useful to investigate thread pool starvation issues. For more information about how to use these events for diagnostic purposes, see [logging and tracing .NET applications](../../core/diagnostics/logging-tracing.md) | ||
|
||
## WaitHandleWaitStart event | ||
|
||
This event is emitted at the start of a wait operation on a wait handle. Here is a non-exhaustive list of managed method that could emit this event: | ||
- `Monitor.Wait` | ||
Check failure on line 17 in docs/fundamentals/diagnostics/runtime-wait-handle-events.md
|
||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- `Monitor.Enter` or the C# lock keyword | ||
- `ManualResetEvent.WaitOne` | ||
- `Task.Wait` | ||
|
||
|Keyword for raising the event|Level| | ||
|-----------------------------------|-----------| | ||
|`WaitHandleKeyword` (0x40000000000)|Verbose (5)| | ||
|
||
The following table shows event information. | ||
|
||
|Event|Event ID|Raised when| | ||
|-----------|--------------|-----------------| | ||
|`WaitHandleWaitStart`|301|A wait starts.| | ||
|
||
|Field name|Data type|Description| | ||
|----------------|---------------|-----------------| | ||
|`WaitSource`|`win:UInt8`|`0x0` - Other sources.<br /><br /> `0x1` - The wait originated from managed code through the `Monitor.Wait` method.| | ||
|`AssociatedObjectID`|`win:Pointer`|Address of the associated object (e.g. address of `obj` in the code `lock(obj) {}`).| | ||
|`ClrInstanceID`|`win:UInt16`|Unique ID for the instance of CoreCLR.| | ||
|
||
## WaitHandleWaitStop event | ||
|
||
This event is emitted at the end of a wait operation on a wait handle. | ||
|
||
|Keyword for raising the event|Level| | ||
|-----------------------------------|-----------| | ||
|`WaitHandleKeyword` (0x40000000000)|Verbose (5)| | ||
|
||
The following table shows event information. | ||
|
||
|Event|Event ID|Raised when| | ||
|-----------|--------------|-----------------| | ||
|`WaitHandleWaitStop`|302|A wait stops.| | ||
|
||
|Field name|Data type|Description| | ||
|----------------|---------------|-----------------| | ||
|`ClrInstanceID`|`win:UInt16`|Unique ID for the instance of CoreCLR.| | ||
Check failure on line 54 in docs/fundamentals/diagnostics/runtime-wait-handle-events.md
|
||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
Uh oh!
There was an error while loading. Please reload this page.