ChannelLoggingType Complex Type

Defines the properties of the log file that backs the channel, such as its capacity and whether it is sequential or circular.

<xs:complexType name="ChannelLoggingType">
    <xs:sequence
        minOccurs="0"
    >
        <xs:element name="autoBackup"
            type="boolean"
            minOccurs="0"
         />
        <xs:element name="retention"
            type="boolean"
            default="0"
            minOccurs="0"
         />
        <xs:element name="maxSize"
            type="UInt64Type"
            default="1048576"
            minOccurs="0"
         />
        <xs:any
            processContents="lax"
            minOccurs="0"
            maxOccurs="unbounded"
            namespace="##other"
         />
    </xs:sequence>
    <xs:anyAttribute
        processContents="lax"
        namespace="##other"
     />
</xs:complexType>

Child elements

ElementTypeDescription
autoBackup boolean

Determines whether to create a new log file when the current log file reaches its maximum size. Set to true to request that the service create a new file when the log file reaches its maximum size; otherwise, false. You can set autoBackup to true only if retention is set to true. The default is false.

There is no limit to the number of backup files that the service can create (limited only by available disk space). The backup file names are of the form Archive-channelName-timestamp.evtx and are located in %windir%\System32\winevt\Logs folder.

maxSize UInt64Type

The maximum size, in bytes, of the log file. The default (and minimum) value is 1 MB. If the physical log size is less than the configured maximum size and additional space is required in the log to store events, the service will allocate another block of space even if the resulting physical size of the log will be larger than the configured maximum size. The service allocates blocks of 1 MB so the physical size could grow to up to 1 MB larger than the configured max size.

retention boolean

Determines whether the log file is a sequential or circular log file. Set to true for a sequential log file and false for a circular log file. The default is false for Admin and Operational channel types and true for Analytic and Debug channel types.

To query a circular log, you must first disable the channel.

Remarks

You can specify the maxSize attribute for any channel type.

You can specify the autoBackup attribute only for Admin and Operational channel types.

You can set the retention attribute to false (circular logging) for Admin and Operational channel types. You can set the retention attribute to false (circular logging) for Analytic and Debug channel types but to view the events in the Windows Event Viewer, you will need to first disable the channel. Note that when you enable the channel again, the events are removed from the channel.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

 

 

Show: