|
|
<html>
<head><meta http-equiv=Content-Type content="text/html; charset=windows-1252"><meta name=Generator content="Microsoft Word 10 (filtered)"><title>Creating Trace Log Sessions</title>
<style><!--
/* Font Definitions */ @font-face {font-family:Verdana; panose-1:2 11 6 4 3 5 4 4 2 4;}@font-face {font-family:"MS Sans Serif"; panose-1:0 0 0 0 0 0 0 0 0 0;} /* Style Definitions */ p.MsoNormal, li.MsoNormal, div.MsoNormal {margin:0in; margin-bottom:.0001pt; font-size:12.0pt; font-family:"Times New Roman";}h1 {margin-top:12.0pt; margin-right:0in; margin-bottom:3.0pt; margin-left:0in; page-break-after:avoid; font-size:16.0pt; font-family:Arial; font-weight:bold;}h3 {margin-right:0in; margin-left:0in; font-size:13.5pt; font-family:"Times New Roman"; font-weight:bold;}h4 {margin-top:12.0pt; margin-right:0in; margin-bottom:3.0pt; margin-left:0in; page-break-after:avoid; font-size:14.0pt; font-family:"Times New Roman"; font-weight:bold;}a:link, span.MsoHyperlink {color:blue; text-decoration:underline;}a:visited, span.MsoHyperlinkFollowed {color:blue; text-decoration:underline;}p {margin-right:0in; margin-left:0in; font-size:12.0pt; font-family:"Times New Roman";}@page Section1 {size:8.5in 11.0in; margin:1.0in 1.25in 1.0in 1.25in;}div.Section1 {page:Section1;}--></style>
</head>
<body lang=EN-US link=blue vlink=blue>
<div class=Section1>
<h1><span style='font-size:24.0pt;font-family:"Times New Roman"'>Creating NewTrace Log Sessions</span></h1>
<h4><span style='font-size:12.0pt'>Using TraceView To Create A New Log Session</span></h4>
<p style='margin-bottom:12.0pt'>TraceView can be started by running it from thecommand-line with no options, or double clicking its icon in Windows Explorer. A new trace logging session may be started by selecting "File"and then "Create New Log Session". Alternatively, rightclicking any blank area of the Log Session window causes a pop-up menu toappear from which appropriate action can be selected.</p>
<p style='margin-bottom:12.0pt'><br><img width=852 height=187 src="CreatingNewTraceLogSessions_files/image001.jpg"></p>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>Selecting �Create New Log Session� pops up the </span><span style='font-size:12.0pt'>Create New Log Session</span><span style='font-size:12.0pt;font-weight:normal'> window. This window lists all the providers that are active forthis log session by PDB file name, CTL file name, Kernel Logger name, orcontrol GUID, depending on how the control information is provided. Sinceno trace providers have been defined yet, the Provider List is initially empty.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=441 height=362src="CreatingNewTraceLogSessions_files/image002.jpg"></span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>To add a trace provider, click the </span><span style='font-size:12.0pt'>AddProvider </span><span style='font-size:12.0pt;font-weight:normal'>button tolaunch the </span><span style='font-size:12.0pt'>Provider Control GUID Setup</span><spanstyle='font-size:12.0pt;font-weight:normal'> dialog:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'><img width=413height=442 src="CreatingNewTraceLogSessions_files/image003.jpg"></span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'> </span><spanstyle='font-size:12.0pt'><br></span><span style='font-size:12.0pt;font-weight:normal'>There are fourpossible way to identify a trace provider to TraceView:</span></h3>
<h3 style='margin-left:.5in;text-indent:-.25in'><span style='font-size:12.0pt;font-weight:normal'>1. Identify a PDB file associated withthe trace provider. For example, when building a driver that includessupport for ETW, the created PDB file contains both the Control and Format GUIDinformation used by the driver. Identifying the PDB file associated witha trace provider is the quickest and easiest way to get started with tracing.</span></h3>
<h3 style='margin-left:.5in;text-indent:-.25in'><span style='font-size:12.0pt;font-weight:normal'>2. Identify a GUID control file (byconvention, file type .CTL), which is a text file containing the controlGUID. This is the same .CTL file type that may be familiar from using theTraceLog command-line utility.</span></h3>
<h3 style='margin-left:.5in;text-indent:-.25in'><span style='font-size:12.0pt;font-weight:normal'>3. Manually enter (or paste) the controlGUID into the space provided by TraceView in the format:00000000-0000-0000-0000-000000000000.</span></h3>
<h3 style='margin-left:.5in;text-indent:-.25in'><span style='font-size:12.0pt;font-weight:normal'>4. The NT Kernel Logger can be selectedas a provider and the Kernel Logger control information will be usedautomatically.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'>The method used to identify the trace provider is selected by clickingon the appropriate radio button in the dialog above. If the PDB File orCTL File method is selected, the file name and path information may be enteredmanually or the browse button (the button with ��� to the right of the edit boxfor the file name) may be used to browse for the correct file. Forexample, clicking the ��� browse button to the right of the PDB file edit box,brings up the following dialog, which has been used to selected the file tracedrv.pdb:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=428 height=273src="CreatingNewTraceLogSessions_files/image004.jpg"></span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>Clicking �Open� in the Open PDB File dialog opens the indicated file andreturns to the </span><span style='font-size:12.0pt'>Provider Control GUID Setup</span><spanstyle='font-size:12.0pt;font-weight:normal'> dialog:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'><img width=413height=442 src="CreatingNewTraceLogSessions_files/image005.jpg"></span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>Clicking �OK� in the </span><span style='font-size:12.0pt'>Provider ControlGUID Setup</span><span style='font-size:12.0pt;font-weight:normal'> dialogreturns to the </span><span style='font-size:12.0pt'>Log Session ProvidersDialog</span><span style='font-size:12.0pt;font-weight:normal'>. The nameof the PDB file has now been filled into the Provider List indicating aprovider has been supplied.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'><img width=441height=362 src="CreatingNewTraceLogSessions_files/image006.jpg"></span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'><br>At this point, additional providers may be added to this log session byclicking �Add Provider� again and following the procedures above.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'>When all providers have been identified, the �Next� button is selectedto display the </span><span style='font-size:12.0pt'>Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> pane of the </span><spanstyle='font-size:12.0pt'>Create New Log Session</span><span style='font-size:12.0pt;font-weight:normal'> dialog:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=441 height=362src="CreatingNewTraceLogSessions_files/image007.jpg"></span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'><br>The </span><span style='font-size:12.0pt'>Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> pane allows the user to definewhether the trace log session will generate real-time output, or whether datawill be logged to a trace log data (.etl) file, or both. The name of thebinary log file may be changed or browsed for from this dialog. A uniquename for the log session may be provided as well. Default names for boththe log file and log session are provided as shown. </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'>Trace log listing and summary output files can also be generated byTraceView. These files are identical to those generated by theTraceFmt command-line utility. Control of the generation of these files,and setting of their names, is accomplished by clicking on the �</span><spanstyle='font-size:12.0pt'>Advanced Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> >>� button. </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=433 height=361src="CreatingNewTraceLogSessions_files/image008.jpg"></span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>The default log session options can be changed by clicking on the �</span><spanstyle='font-size:12.0pt'>Advanced Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> >>� button and selecting the</span><span style='font-size:12.0pt'>Log Session Parameter Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> tab of the </span><spanstyle='font-size:12.0pt'>Advanced Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> dialog:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><img width=433 height=361src="CreatingNewTraceLogSessions_files/image009.jpg"></span></h3>
<h3><span style='font-size:12.0pt;font-weight:normal'><br>Grayed out items cannot be modified, but parameters listed with dark text mayhave their values altered. Some parameters are exclusive of others, soproviding values for certain parameters may clear or alter the values ofothers. Clicking on the �OK� button exits the </span><spanstyle='font-size:12.0pt'>Advanced Log Session Options</span><spanstyle='font-size:12.0pt;font-weight:normal'> dialog. </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'>Clicking on the �Finish� button back in the </span><spanstyle='font-size:12.0pt'>Create New Log Session</span><span style='font-size:12.0pt;font-weight:normal'> dialog exits the dialog. TraceView displaysinformation about the newly created log session in the Log Session Window (thetop window pane in the screen shot below), and an empty (until trace event arepicked up) Log Session Output Display Window (the bottom pane):</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=895 height=306src="CreatingNewTraceLogSessions_files/image010.jpg"></span></h3>
<h3><span style='font-size:12.0pt'><br>IMPORTANT NOTE: </span><span style='font-size:12.0pt;font-weight:normal'>Thereis a column in the log session display titled �State� which indicates therunning state of the log session. The possible values in this column are�GROUPING�, �UNGROUPING�, �RUNNING�, �STOPPING�, �STOPPED�, or �EXISTING�.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'>The trace log session will start automatically upon successfulcreation. Right clicking on the log session line associated with thedesired log session in the upper window brings up a menu with options for thelog session:</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><img width=895 height=306src="CreatingNewTraceLogSessions_files/image011.jpg"></span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt;font-weight:normal'><br>Trace output will begin to appear in the (lower) Output Display Window as soonas it�s created.</span></h3>
<h3 style='margin-bottom:13.5pt'><span style='font-size:12.0pt'> </span></h3>
<h3><span style='font-size:12.0pt'><img width=895 height=306src="CreatingNewTraceLogSessions_files/image012.jpg"></span></h3>
<p><br>In addition to displaying the trace log session parameters and the state of thelog session in the Trace Log Session List Window, three columns, Event Count,Lost Events, and Buffers Read, give up to date values for active log sessions.</p>
<p><b>Creating Additional Log Sessions</b></p>
<p style='margin-bottom:12.0pt'>Additional Log Sessions may be added toTraceView the same way as the first. Each log session results in a newline being added to the Log Se<img width=2 height=1src="CreatingNewTraceLogSessions_files/image015.jpg">ssion Window to describethat session, and creation of a new Output Display Window. This is shownbelow:</p>
<p style='margin-bottom:12.0pt'> </p>
<p style='margin-bottom:12.0pt'><img width=893 height=366src="CreatingNewTraceLogSessions_files/image016.jpg"></p>
<p style='margin-bottom:12.0pt'> </p>
<p align=center style='margin-bottom:12.0pt;text-align:center'><b><spanstyle='font-size:10.0pt;font-family:Verdana'><ahref="CreatingNewTraceLogSessions.htm">Top of page</a></span></b></p>
<p align=center style='margin-bottom:12.0pt;text-align:center'> </p>
<table class=MsoNormalTable border=0 cellspacing=0 cellpadding=0 width=873 style='width:654.65pt'> <tr style='height:.05in'> <td style='background:aqua;padding:.75pt .75pt .75pt .75pt;height:.05in'> <p class=MsoNormal style='line-height:3.6pt'><span style='font-size:2.0pt'> </span></p> </td> </tr></table>
<p><b><span style='font-size:11.0pt;font-family:"MS Sans Serif"'>� MicrosoftCorporation 2002</span></b></p>
<h3><span style='font-weight:normal'> </span></h3>
</div>
</body>
</html>
|
