HeapEventCollector

  • Article

Represents a collector for heap events.

Element Hierarchy

Syntax

<HeapEventCollector Id       = IdType
                    Base     = string
                    Name     = string
                    Realtime = boolean
                    Secure   = boolean>

  <!-- Child elements -->
  BufferSize,
  Buffers,
  StackCaching,
  MaximumFileSize,
  FileMax
</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
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 Default
BufferSize Describes the size of each buffer, in KB. Optional, 1. 128
Buffers Describes the number of buffers to be allocated when starting a session. Optional, 1. 64
StackCaching Describes stack caching attributes of collectors. Optional, 1.
MaximumFileSize Describes maximum trace file size. Optional, 1.
FileMax Describes the maximum number of instances of the log file that ETW creates for Autologger trace. Optional, 1.

Parent Elements

Element Description
Profiles 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.

Elements

Inheritance