Skip to content

Add POH events #19480

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 20, 2020
+64 −0
Merged

Add POH events #19480

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79de284
Add POH events
davmason Jul 15, 2020
1eb66f8
add GCAllocationTick_V3 to the index
davmason Aug 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions docs/framework/performance/garbage-collection-etw-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ This category consists of the following events:
- [GCStart_V1 Event](#gcstart_v1-event)
- [GCEnd_V1 Event](#gcend_v1-event)
- [GCHeapStats_V1 Event](#gcheapstats_v1-event)
- [GCHeapStats_V2 Event](#gcheapstats_v2-event)
- [GCCreateSegment_V1 Event](#gccreatesegment_v1-event)
- [GCFreeSegment_V1 Event](#gcfreesegment_v1-event)
- [GCRestartEEBegin_V1 Event](#gcrestarteebegin_v1-event)
- [GCRestartEEEnd_V1 Event](#gcrestarteeend_v1-event)
- [GCSuspendEE_V1 Event](#gcsuspendee_v1-event)
- [GCSuspendEEEnd_V1 Event](#gcsuspendeeend_v1-event)
- [GCAllocationTick_V2 Event](#gcallocationtick_v2-event)
- [GCAllocationTick_V3 Event](#gcallocationtick_v3-event)
- [GCFinalizersBegin_V1 Event](#gcfinalizersbegin_v1-event)
- [GCFinalizersEnd_V1 Event](#gcfinalizersend_v1-event)
- [GCCreateConcurrentThread_V1 Event](#gccreateconcurrentthread_v1-event)
Expand Down Expand Up @@ -108,6 +110,41 @@ The following table shows the event data:
|GCHandleCount|win:UInt32|The number of garbage collection handles in use.|
|ClrInstanceID|win:UInt16|Unique ID for the instance of CLR or CoreCLR.|

## GCHeapStats_V2 Event

The following table shows the keyword and level:

|Keyword for raising the event|Level|
|-----------------------------------|-----------|
|`GCKeyword` (0x1)|Informational (4)|

The following table shows the event information:

|Event|Event ID|Description|
|-----------|--------------|-----------------|
|`GCHeapStats_V2`|4|Shows the heap statistics at the end of each garbage collection.|

The following table shows the event data:

|Field name|Data type|Description|
|----------------|---------------|-----------------|
|GenerationSize0|win:UInt64|The size, in bytes, of generation 0 memory.|
|TotalPromotedSize0|win:UInt64|The number of bytes that are promoted from generation 0 to generation 1.|
|GenerationSize1|win:UInt64|The size, in bytes, of generation 1 memory.|
|TotalPromotedSize1|win:UInt64|The number of bytes that are promoted from generation 1 to generation 2.|
|GenerationSize2|win:UInt64|The size, in bytes, of generation 2 memory.|
|TotalPromotedSize2|win:UInt64|The number of bytes that survived in generation 2 after the last collection.|
|GenerationSize3|win:UInt64|The size, in bytes, of the large object heap.|
|TotalPromotedSize3|win:UInt64|The number of bytes that survived in the large object heap after the last collection.|
|FinalizationPromotedSize|win:UInt64|The total size, in bytes, of the objects that are ready for finalization.|
|FinalizationPromotedCount|win:UInt64|The number of objects that are ready for finalization.|
|PinnedObjectCount|win:UInt32|The number of pinned (unmovable) objects.|
|SinkBlockCount|win:UInt32|The number of synchronization blocks in use.|
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davmason
Should rather be SyncBlockCount, but from looking at the code looks like it the name is cut in stone
https://github.com/dotnet/runtime/blob/921bca0ae0d07a7dfd83d5d70eaf49759ab8463b/src/coreclr/vm/gctoclreventsink.h#L29

|GCHandleCount|win:UInt32|The number of garbage collection handles in use.|
|ClrInstanceID|win:UInt16|Unique ID for the instance of CLR or CoreCLR.|
|GenerationSize4|win:UInt64|The size, in bytes, of the pinned object heap.|
|TotalPromotedSize4|win:UInt64|The number of bytes that survived in the pinned object heap after the last collection.|

## GCCreateSegment_V1 Event

The following table shows the keyword and level:
Expand Down Expand Up @@ -250,6 +287,33 @@ The following table shows the event data:
|TypeName|win:UnicodeString|The name of the type that was allocated. When there are several types of objects that were allocated during this event, this is the type of the last object allocated (the object that caused the 100 KB threshold to be exceeded).|
|HeapIndex|win:UInt32|The heap where the object was allocated. This value is 0 (zero) when running with workstation garbage collection.|

## GCAllocationTick_V3 Event

The following table shows the keyword and level:

|Keyword for raising the event|Level|
|-----------------------------------|-----------|
|`GCKeyword` (0x1)|Informational (4)|

The following table shows the event information:

|Event|Event ID|Raised when|
|-----------|--------------|-----------------|
|`GCAllocationTick_V3`|10|Each time approximately 100 KB is allocated.|

The following table shows the event data:

|Field name|Data type|Description|
|----------------|---------------|-----------------|
|AllocationAmount|win:UInt32|The allocation size, in bytes. This value is accurate for allocations that are less than the length of a ULONG (4,294,967,295 bytes). If the allocation is greater, this field contains a truncated value. Use `AllocationAmount64` for very large allocations.|
|AllocationKind|win:UInt32|0x0 - Small object allocation (allocation is in small object heap).<br /><br /> 0x1 - Large object allocation (allocation is in large object heap).|
|ClrInstanceID|win:UInt16|Unique ID for the instance of CLR or CoreCLR.|
|AllocationAmount64|win:UInt64|The allocation size, in bytes. This value is accurate for very large allocations.|
|TypeId|win:Pointer|The address of the MethodTable. When there are several types of objects that were allocated during this event, this is the address of the MethodTable that corresponds to the last object allocated (the object that caused the 100 KB threshold to be exceeded).|
|TypeName|win:UnicodeString|The name of the type that was allocated. When there are several types of objects that were allocated during this event, this is the type of the last object allocated (the object that caused the 100 KB threshold to be exceeded).|
|HeapIndex|win:UInt32|The heap where the object was allocated. This value is 0 (zero) when running with workstation garbage collection.|
|Address|win:Pointer|The address of the last allocated object.|

## GCFinalizersBegin_V1 Event

The following table shows the keyword and level:
Expand Down