ITraceDataCollector interface

Collects trace events from registered providers.

This interface defines the trace session. The session starts when the data collector set runs. The collection of trace data providers defines the providers that you want to enable to the session when the session runs.

To create this data collector, call the IDataCollectorCollection::CreateDataCollector or IDataCollectorCollection::CreateDataCollectorFromXml method. For details on the XML that you pass to CreateDataCollectorFromXml, see Remarks.

Members

The ITraceDataCollector interface inherits from IDataCollector. ITraceDataCollector also has these types of members:

Properties

The ITraceDataCollector interface has these properties.

PropertyDescription

BufferSize

Retrieves or sets the suggested buffer size for each buffer in the event tracing session.

BuffersLost

Retrieves the number of buffers that were not written to the log file.

BuffersWritten

Retrieves the number of buffers written to the log file.

ClockType

Retrieves or sets the clock resolution to use when logging the time stamp for each event.

EventsLost

Retrieves the number of events that were not written to the buffer.

ExtendedModes

Retrieves or sets the extended log file modes.

FlushTimer

Retrieves or sets the time to wait before flushing buffers.

FreeBuffers

Retrieves the number of buffers that are allocated but unused in the event tracing session's buffer pool.

Guid

Retrieves or sets the session GUID.

IsKernelTrace

Retrieves a value that indicates whether the trace contains kernel providers.

MaximumBuffers

Retrieves or sets the maximum number of buffers allocated for the event tracing session's buffer pool.

MinimumBuffers

Retrieves or sets the minimum number of buffers allocated for the event tracing session's buffer pool.

NumberOfBuffers

Retrieves or sets the suggested number of buffers to use for logging.

PreallocateFile

Retrieves or sets a value that indicates whether PLA should allocate the entire log file size before logging.

ProcessMode

Retrieves or sets a value that indicates whether the session is a private, in-process session.

RealTimeBuffersLost

Retrieves the number of buffers that were not delivered in real time to the consumer.

SessionId

Retrieves the session identifier.

SessionName

Retrieves or sets the name of the session.

SessionThreadId

Retrieves the current thread of the log session, if the thread is running.

StreamMode

Retrieves or sets the logging mode of the trace session.

TraceDataProviders

Retrieves the list of providers enabled for this trace session.

 

Remarks

The following example shows the XML that you can use to initialize this object if you call the IDataCollectorCollection::CreateDataCollectorFromXml method to create it. The IDataCollector::Xml property also returns this XML.


<TraceDataCollector>
    <BufferSize/>
    <BuffersLost/>  <!-- Output only -->
    <BuffersWritten/>  <!-- Output only -->
    <ClockType/>
    <EventsLost/>  <!-- Output only -->
    <ExtendedMode/>
    <FlushTimer/>
    <FreeBuffers/>  <!-- Output only -->
    <Guid/>
    <IsKernelTrace/>
    <MaximumBuffers/>
    <MinimumBuffers/>
    <NumberOfBuffers/>
    <PreallocateFile/>
    <ProcessMode/>
    <RealTimeBuffersLost/>  <!-- Output only -->
    <SessionId/>  <!-- Output only -->
    <SessionName/>
    <SessionThreadId/>  <!-- Output only -->
    <StreamMode/>
    <TraceDataProvider>  <!-- Specify for each provider -->
        <DisplayName/>
        <FilterData/>
        <FilterType/>
        <Guid/>
        <KeywordsAll>
            <Description/>
            <ValueMapType/>
            <Value/>
        </KeywordsAll>
        <KeywordsAny>
            <Description/>
            <ValueMapType/>
            <Value/>
        <KeywordsAny/>
        <Level>
            <Description/>
            <ValueMapType/>
            <Value/>
        <Level/>
        <Properties/>
    </TraceDataProvider>
</TraceDataCollector>

Note that the example does not show the property elements inherited from IDataCollector that you also need to specify.

When you specify the XML to create the collector, you can specify only the elements for the properties that you want to set. If you do not specify a property, PLA provides a default value. When you retrieve the XML for the collector, the XML provides all elements, including those from IDataCollector.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Pla.h

DLL

Pla.dll

See also

IDataCollector

 

 

Community Additions

ADD
Show: