diff --git a/docs/fundamentals/diagnostics/runtime-wait-handle-events.md b/docs/fundamentals/diagnostics/runtime-wait-handle-events.md index 78be7732d4097..5b2a50aab26d9 100644 --- a/docs/fundamentals/diagnostics/runtime-wait-handle-events.md +++ b/docs/fundamentals/diagnostics/runtime-wait-handle-events.md @@ -1,15 +1,15 @@ --- -title: "Wait handle runtime events" +title: "Wait-handle runtime events" description: See ETW events that collect information specific to the wait handles. -ms.date: "05/27/2024" +ms.date: "05/27/2025" helpviewer_keywords: - "wait handle events (CoreCLR)" - "ETW, EventPipe, LTTng wait handle events (CoreCLR)" --- -# .NET runtime wait handle events +# .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) +Runtime wait-handle 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 @@ -20,36 +20,36 @@ This event is emitted at the start of a wait operation on a wait handle. Here is - `ManualResetEvent.WaitOne` - `Task.Wait` -|Keyword for raising the event|Level| -|-----------------------------------|-----------| -|`WaitHandleKeyword` (0x40000000000)|Verbose (5)| +| 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.| +| Event | Event ID | Raised when | +|-----------------------|----------|----------------| +| `WaitHandleWaitStart` | 301 | A wait starts. | -|Field name|Data type|Description| -|----------------|---------------|-----------------| -|`WaitSource`|`win:UInt8`|`0x0` - Other sources.

`0x1` - The wait originated from managed code through the `Monitor.Wait` method.| -|`AssociatedObjectID`|`win:Pointer`|Address of the associated object (for example, address of `obj` in the code `lock(obj) {}`).| -|`ClrInstanceID`|`win:UInt16`|Unique ID for the instance of CoreCLR.| +| Field name | Data type | Description | +|-----------------|--------------|----------------------------------------| +| `WaitSource` | `win:UInt8` | `0x0` - Other sources.

`0x1` - The wait originated from managed code through the `Monitor.Wait` method. | +| `AssociatedObjectID` | `win:Pointer` | Address of the associated object (for example, 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)| +| 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.| +| 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.| +| Field name | Data type | Description | +|-----------------|--------------|----------------------------------------| +| `ClrInstanceID` | `win:UInt16` | Unique ID for the instance of CoreCLR. | diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index bea6baa9833bb..1691cf57eed24 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -479,6 +479,8 @@ items: href: ../../fundamentals/diagnostics/runtime-type-events.md - name: Tiered compilation events href: ../../fundamentals/diagnostics/runtime-tiered-compilation-events.md + - name: Wait-handle events + href: ../../fundamentals/diagnostics/runtime-wait-handle-events.md - name: Collect diagnostics in containers href: ../../core/diagnostics/diagnostics-in-containers.md - name: Dumps