ETW Tracing

Article
07/03/2007

This sample demonstrates how to implement End-to-End (E2E) tracing using Event Tracing for Windows (ETW) and the ETWTraceListener that is provided with this sample. The sample is based on the Getting Started Sample and includes ETW tracing.

Note:
The setup procedure and build instructions for this sample are located at the end of this topic.

This sample assumes that you are familiar with the Tracing and Message Logging and have read the documentation provided for the Tracing and Message Logging.

Each trace source in the System.Diagnostics tracing model can have multiple trace listeners that determine where and how the data is traced. The type of listener defines the format in which trace data is logged. The following code sample shows how to add the listener to configuration:

<system.diagnostics>
    <sources>
        <source name="System.ServiceModel" 
             switchValue="Verbose,ActivityTracing"
             propagateActivity="true">
            <listeners>
                <add type=
                   "System.Diagnostics.DefaultTraceListener"
                   name="Default">
                   <filter type="" />
                </add>
                <add name="ETW">
                    <filter type="" />
                </add>
            </listeners>
        </source>
    </sources>
    <sharedListeners>
        <add type=
            "Microsoft.ServiceModel.Samples.EtwTraceListener, ETWTraceListener"
            name="ETW" traceOutputOptions="Timestamp">
            <filter type="" />
       </add>
    </sharedListeners>
</system.diagnostics>

Before using this listener, an ETW Trace Session must be started. This session can be started by using Logman.exe or Tracelog.exe. A SetupETW.bat file is included with this sample so that you can setup the ETW Trace Session along with a CleanupETW.bat file for closing the session and completing the log file.

Note:
The setup procedure and build instructions for this sample are located at the end of this topic. For more information about these tools, see https://go.microsoft.com/fwlink/?LinkId=56580

When using the ETWTraceListener, traces are logged in binary .etl files. With ServiceModel tracing turned on, all generated traces appear in the same file. Use Service Trace Viewer Tool for viewing .etl and .svclog log files. The viewer creates an end-to-end view of the system that makes it possible to trace a message from its source to its destination and point of consumption.

The ETW Trace Listener supports circular logging. To enable this feature, go to Start, Run and type cmd to start a command console. In the following command, replace the <logfilename> parameter with the name of your log file.

logman create trace Wcf -o <logfilename> -p "{411a0819-c24b-428c-83e2-26b41091702e}" -f bincirc -max 1000

The -f and -max switches are optional. They specify the binary circular format and max log size of 1000MB respectively. The -p switch is used to specify the trace provider. In our example, "{411a0819-c24b-428c-83e2-26b41091702e}" is the GUID for "XML ETW Sample Provider".

After you have finished logging, you can stop the session with the following command.

Logman stop Wcf

This process generates binary circular logs that you can process with your tool of choice, including Service Trace Viewer Tool or Tracerpt.

You can also review the Circular Tracing sample for more information on an alternative listener to perform circular logging.

To set up, build, and run the sample

Be sure you have performed the One-Time Setup Procedure for the Windows Communication Foundation Samples.
To build the solution, follow the instructions in Building the Windows Communication Foundation Samples.
Before running the sample, run RegisterProvider.bat on the client and server. This sets up the resulting ETWTracingSampleLog.etl file to generate traces that can be read by the Trace Viewer. This file can be found in the C:\logs folder. If this folder does not exist, it must be created or no traces are generated. Then, run SetupETW.bat on the client and server machines to begin the ETW Trace Session. The SetupETW.bat file can be found under the CS\Client folder.
To run the sample in a single- or cross-machine configuration, follow the instructions in Running the Windows Communication Foundation Samples.
When the sample is completed, run CleanupETW.bat to complete the creation of the ETWTracingSampleLog.etl file.
Open the ETWTracingSampleLog.etl file from within the Trace Viewer. You will be prompted to save the binary formatted file as a .svclog file.
Open the newly created .svclog file from within the Trace Viewer to view the ETW and ServiceModel traces.

Footer image

Partager via

ETW Tracing

To set up, build, and run the sample

Ressources supplémentaires