MaximumFileSize

Article
07/26/2022

Sets the maximum file size of the tracing file (.etl). If the FileMode attribute is Sequential the trace stops when the file size reaches the given size. If the FileMode attribute is Circular, the file keeps the latest events.

Element Hierarchy

<WindowsPerformanceRecorder>
- <Profiles>
  - <SystemCollector>
    - <MaximumFileSize>
  - <EventCollector>
    - <MaximumFileSize>
  - <HeapEventCollector>
    - <MaximumFileSize>
  - <HypervisorEventCollector>
    - <MaximumFileSize>
  - <Profile>
    - <Collectors>
      - <SystemCollectorId>
        
        <MaximumFileSize>
      - <EventCollectorId>
        
        <MaximumFileSize>
      - <HeapEventCollectorId>
        
        <MaximumFileSize>
      - <HypervisorEventCollectorId>
        
        <MaximumFileSize>

Syntax

<MaximumFileSize Operation               = "Set" | "Add" | “Remove”
         Value                   = unsignedLong
         FileMode = "Circular" | "Sequential">
</MaximumFileSize>

Attributes and Elements

Attributes

Attribute	Description	Data type	Required	Default
Operation	Indicates whether MaximumFileSize should be set or added.	This attribute can have one of the following values: Set Add Remove	No	Set
Value	Indicates the number of MaximumFileSize in MB.	unsignedLong	Yes
FileMode	When set to `Sequential` the trace stops when it reaches the given size.	String	No	Circular

Child Elements

None.

Parent Elements

Element	Description
EventCollector	Represents an event collector.
EventCollectorId	Represents an event collector identifier.
HeapEventCollector	Represents a heap event collector.
HeapEventCollectorId	Represents a heap event collector identifier.
SystemCollector	Represents a system collector.
SystemCollectorId	Represents a system collector identifier.
HypervisorCollector	Represents a hypervisor collector.
HypervisorCollectorId	Represents a hypervisor collector identifier.

Remarks

This element is used only for file mode capture.

Example

The following examples show how this element is used in event collector definitions.

The example sets 40 buffers of 128 KB each and the maximum file size to 100 MB. The tracing session will not stop when the file size reaches 100 MB by keeping the latest event data.

<EventCollector Id="EventCollector_MultimediaEx" Name="WPDiet MultimediaEx">
  <BufferSize Value="128"/>
  <Buffers Value="40"/>
  <MaximumFileSize Value="100" FileMode="Circular"/>
</EventCollector>

HypervisorEventCollector