HeapEventCollector
Applies To: Windows 8, Windows 8.1
Represents a collector for heap events.
Element Hierarchy
<WindowsPerformanceRecorder>
<Profiles>
<HeapEventCollector>
Syntax
<HeapEventCollector Id = IdType
Base = string
Name = string
FileName = string
Realtime = boolean
Secure = boolean>
<!-- Child elements -->
BufferSize,
Buffers,
StackCaching
</HeapEventCollector>
Attributes and Elements
Attributes
| Attribute | Description | Data type | Required | Default |
|---|---|---|---|---|
Id |
Uniquely identifies the heap event collector. |
String that must have at least one character and cannot contain colons (:) or spaces. |
Yes |
|
Base |
Indicates the base of the collector. |
string |
No |
|
Name |
Indicates the name of the heap event collector. |
string |
Yes |
|
FileName |
Indicates the name of the file to which events should be written. |
string |
Yes |
|
Realtime |
Indicates whether the event collector operates in real time. |
boolean |
No |
false |
Secure |
If set to "true", indicates that only users with administrative privileges and proper access rights can control the session. If set to "false", indicates that all users can control the session. |
boolean |
No |
true |
Child Elements
| Element | Description | Requirement |
|---|---|---|
Describes the size of each buffer, in KB. |
Required, exactly 1. |
|
Describes either the number of buffers to be allocated when starting a session or the percentage of total memory to be allocated for the session, depending on the value of the PercentageOfTotalMemory attribute. |
Required, exactly 1. |
|
Describes stack caching attributes of collectors. |
Parent Elements
| Element | Description |
|---|---|
Represents a collection of collectors, providers, and profiles. |
Remarks
Derived event collectors have the attributes of the base collector by default. These can be overridden by explicitly specifying them in the derived collector. For more information, see Inheritance.