share point diagnostics tool

7/23/2019 Share Point Diagnostics Tool

http://slidepdf.com/reader/full/share-point-diagnostics-tool 1/22

SharePoint Diagnostics Tool(SPDiag)

CONTENTS

Introduction to SPDiag...................................................................................................2

Setup and configuration.................................................................................................4

Installing SPDiag........................................................................................................4

Configuring the tool....................................................................................................4

Configuring the farm servers......................................................................................5

Using SPDiag.................................................................................................................7

Creating a new proect...............................................................................................!

"or#ing with data.......................................................................................................!

$nown issues...............................................................................................................2%

Unhandled e&ception in SPDiag when 'amed Pipes S() connection is used.......2%

Data*ase column in custom reports reads +',- /I)0)1................................2%

Installed ph3sical memor3 value in Snapshot is incorrect for virtualied SharePointservers......................................................................................................................2%

Unicode characters in U)s are logged *3 IIS as 6uestion mar#s..........................2%

arm calculated performance counters are not displa3ed.......................................22Data is missing for some or all of the farm servers..................................................22



Introduction to SPDiag-he SharePoint Diagnostic tool 8SPDiag9 version %.:; included with the latest release of the SharePoint dministration-ool#it; was created to simplif3 and standardie trou*leshooting of SharePoint Products and -echnologies; and to provide a

unified view of collected data. SharePoint Products and -echnologies administrators can use SPDiag to gather relevantinformation from a farm; displa3 the results in a meaningful wa3; identif3 performance issues; and e&port the collected dataand reports for anal3sis *3 <icrosoft support personnel.

-he SharePoint Products and -echnologies platform is highl3 comple& and can *e used for a wide variet3 of uses.Deplo3ing; managing; and trou*leshooting SharePoint Products and -echnologies re6uires e&tensive #nowledge spanningmultiple technolog3 areas; including securit3; networ#ing; such "e* technologies as SP=; and S() Server.

-raditionall3; SharePoint Server trou*leshooting involves manuall3 collecting a wide arra3 of data from servers in theaffected farm; and then manuall3 anal3ing the data to determine the source of the pro*lem. -his process can *e comple&and time>consuming; and data collection itself can place a significant load on the servers.

SPDiag is designed to collect and review data from SharePoint Products and -echnologies "e* servers; applicationservers; and S() servers; and store the collected data for each proect in a S() Server data*ase for retrieval and anal3sis.SPDiag can collect performance data from IIS logs; U)S logs; and performance counters; and can also collect live data from

the servers using "indows <anagement Instrumentation 8"<I9. Data can then *e displa3ed in the -rends pane of theSPDiag interface and filtered to reveal trends; *ottlenec#s; and other performance issues that would otherwise re6uiresignificant manual data processing to uncover. ?ou can also view the individual components and the logical structure of thefarm in the Snapshot pane.

SPDiag operates in the conte&t of a project ; which is the container used to store collected data for a specific farm. 1achproect has its own data*ase; and 3ou can create man3 proects for a single farm; su*ect onl3 to data*ase server resourcelimitations. Proects can *e saved and reopened again at a later time; and new data can *e added to a proect *etweenSPDiag sessions. ?ou cannot move data *etween proects; and 3ou cannot collect data from more than one farm in a singleproect. 0ecause all SPDiag proect data is stored in a S() Server data*ase; 3ou can *ac# up a proect data*ase or move itto another data*ase server.

SPDiag can *e used in online or offline modes. In online mode; SPDiag is installed on a "e* server *elonging to the farm3ou want to trou*leshoot. -his allows SPDiag to connect to the farm and collect data. In offline mode; SPDiag is installed ona computer that is not a part of a farm. It can onl3 *e used to review e&isting SPDiag proects; and cannot collect data.

?ou can e&port collected data and reports as data files; which can then *e sent to <icrosoft support technicians for anal3sis.-his can help to facilitate remote trou*leshooting *3 ensuring that the re6uired data is captured on>site; and *3 consolidatingthe data in a standardied format.

Setup and configurationead this section for information a*out SPDiag installation; configuration details; and how to configure farm servers for thetrou*leshooting process.

Installing SPDiagSPDiag is installed with the latest version of the SharePoint dministration -ool#it [email protected]#AB)in#Id%4%5:49.

?ou can install SPDiag on an3 computer in the SharePoint farm. -o ensure optimum performance; 3ou should install SPDiagon the farm server with the least resource usage. or e&ample; a dedicated Central dministration "e* server would *e an

ideal host.

In order to collect performance counter data; 3ou must install the .'1- ramewor# .5 on the SPDiag host computer. -odispla3 performance counter data; 3ou will also need to install the <icrosoft Chart Controls for the .'1- ramewor# .5.

-o download the .'1- ramewor# .5; see <icrosoft .'1- ramewor# .5 [email protected]#AB)in#Id%4%5:!9.

-o download the <icrosoft Chart Controls; see <icrosoft Chart Controls for <icrosoft .'1- ramewor# .5 [email protected]#AB)in#Id%4%5%29.

http://go.microsoft.com/fwlink/?LinkId=141504











Note:

SPDiag can *e used in online or offline modes. In online mode; SPDiag is installed on a "e* server *elonging to the farm3ou want to trou*leshoot. -his allows SPDiag to connect to the farm and collect data. In offline mode; SPDiag is installedon a computer that is not a part of a farm. It can onl3 *e used to review e&isting SPDiag proects; and cannot collect data.

Caution:

Using SPDiag can consume significant resources; such as networ# *andwidth; on the data*ase server used to host the

proect data*ase. <a#e sure that *oth the proect data*ase server and the networ# *etween the proect data*ase serverand the farm have ade6uate resources availa*le for running SPDiag.SPDiag does not consume su*stantial resources on the host computer.

-he default SPDiag installation director3 is C@EProgram ilesE<icrosoftESPdministration-ool#itESharePoint Diagnostics.

Configuring the tool fter 3ou open a new SPDiag proect; and *efore 3ou *egin collecting data with SPDiag; 3ou should use the Options dialog*o& to configure the tool. In most cases; the default values will wor#; *ut if performance monitor file or IIS log file locationshave *een changed from their default locations on an3 of the servers in the farm; 3ou can specif3 their locations here.

?ou can also specif3 a networ# share from which to collect log files if 3ou have a log file archive on the networ#.

iles ta*,n the Files ta*; 3ou can set the locations of data files that SPDiag uses to collect information. 'ote that for each server;3ou must specif3 the e&act local path to the folders containing the log files. ?ou can add multiple paths with each entr3separated *3 a semicolon. SPDiag does not search recursivel3; so an3 su*directories containing log files must *e addede&plicitl3.

• Select server: Use this field to select the "e* server on which 3ou wish to specif3 file locations.

• Performance counter file location: Use this field to set the path for the performance counter files on the "e*

server.

• IIS log file location: Use this field to set the path for the IIS log files on the server.

<isc ta*,n the Misc ta*; 3ou can set various options for collected information.

• Log upload speed: Use this field to specif3 the rate at which logs will *e uploaded to the proect data*ase. -here

are three settings@ Low; Medium; and ig!. )ow collects data from one server at a time; <edium collects data from upto 5 servers simultaneousl3; and Figh collects data from up to %: servers simultaneousl3. -he default is <edium.

If 3ou are using the farmGs data*ase server to store the proect data*ase; 3ou should use )ow or <edium to reduce theperformance impact on the data*ase server. If 3ou are using a dedicated computer to host the proect S() Serverdata*ase; 3ou can use Figh for ma&imum performance.

If 3ou want to change the log upload speed after data collection has *egun; 3ou can clic# Cancel in the data collectionnotification window; change the log upload speed; and restart data collection.

• Ma" num#er of rows in custom reports: Use this field to specif3 the num*er of rows 3ou wish to displa3 in

customer reports that 3ou generate. -he default is %:: rows.

• Ma" num#er of rows in merged logs: Use this field to specif3 the num*er of rows 3ou wish to collect from all log

files that are included in the proect. -he default is 5:;::: rows.

• Performance counter time interval $in seconds%: Use this field to specif3 the refresh rate of performance

counters used for data collection. -he default is 5 seconds.

Note:



-his setting does not affect the refresh rate for data collected through )ive Capture. See the HCollectingperformance counter data using )ive CaptureH section later in this article for more information.

Configuring the farm servers0efore 3ou *egin using SPDiag; 3ou must ensure that the servers in the farm are configured to provide the data re6uired *3SPDiag.

"hile most of the data needed for trou*leshooting is logged *3 default on farm servers; there are certain data points that

must *e manuall3 configured.

Configuring performance counters0efore 3ou use SPDiag to collect data from farm servers; 3ou can use the Performance <onitor snap>in 8Perfmon.msc9 tocreate a *inar3 8.*lg9 Perf<on logs on 3our farm servers. SPDiag can collect data from an3 .*lg files it finds in theperformance counter file location 3ou specified for each farm server.

"hen 3ou are trou*leshooting a SharePoint farm; it is helpful to log a wide spectrum of performance data; especiall3processor and memor3 usage; dis# IA,; and important IIS counters. If possi*le; log an3 performance counters that mightcontain useful information on ever3 farm server over a period of time sufficient to capture measurements that span *othpea# and off>pea# farm usage.

?ou can also use SPDiagGs )ive Capture feature to create data collector sets on farm servers. See HCollecting performancecounter data using )ive CaptureH section later in this article for more information.

Configuring IIS logsSPDiag collects information from the IIS logs on "e* servers in the farm. IIS logs most of the re6uired information *3default; *ut SPDiag re6uires certain data that is not logged *3 default.

Use the information in this section to ma#e sure that IIS is correctl3 configured.

-he IIS logs should *e chec#ed to assure that logs are created in the "C 1&tended )og ormat 8the IIS default9; and thatall the fields needed to create reports; as shown in the ta*le *elow; are present in the logs. If the logs are in a non>"Cformat; then 3ou can use )ogParser.e&e to manuall3 convert the logs to the "C format.

Note:

SPDiag assumes that IIS log files are collected in U-C time; while all other logs represent local server time. If 3ou have toconvert 3our logs to "C; IIS logs are imported into )ogParser in U-C. -herefore; *efore collecting converted IIS logswith SPDiag; 3ou should convert all time records in the log files to U-C.

-he following ta*le displa3s the IIS log fields that are commonl3 used for trou*leshooting; and indicates whether the3 arelogged *3 default and whether the3 are re6uired for SPDiag trou*leshooting. 0efore 3ou collect data with SPDiag; it isrecommended that 3ou ena*le an3 fields in this ta*le that are not *eing logged on the "e* servers in 3our farm. If 3ou electto ena*le a field for logging; 3ou should ena*le it on all "e* servers in the farm.

Field &ppears as 'escription Logged #(default)

*e+uired)

-ime ta#en time>ta#en -he length of time that the action too#; inmilliseconds.

'ote that this is a re6uired field for SPDiagtrou*leshooting; and is not ena*led *3 default.

' ?

Fost cs>host -he host header name; if an3.

'ote that this is a re6uired field for SPDiagtrou*leshooting; and is not ena*led *3 default.

' ?

Date date -he date on which the activit3 occurred. ? ?

-ime time -he time; in coordinated universal time 8U-C9; at ? ?



which the activit3 occurred.

Client IP address c>ip -he IP address of the client that made the re6uest. ? ?

<ethod cs>method -he re6uested action; for e&ample; a 1- method. ? ?

UI stem cs>uri>stem -he target of the action; for e&ample; default.htm. ? ?

UI 6uer3 cs>uri>6uer3 -he 6uer3; if an3; that the client was tr3ing to perform. Universal esource Identifier 8UI9 6uer3 is onl3necessar3 for d3namic pages.

? ?

F--P status sc>status -he F--P status code. ? ?

User agent cs8User> gent9

-he *rowser t3pe or other client from which there6uest originated.

? ?

User name cs>username -he name of the authenticated user who accessed3our server. non3mous users are indicated *3 ah3phen.

? '

Server IP

address

s>ip -he IP address of the server on which the log file

entr3 was generated.

? '

Server port s>port -he server port num*er that is configured for theservice.

? '

Protocolsu*status

sc>su*status -he su*status error code. ? '

Service 'ameand Instance'um*er

s>sitename -he Internet service name and instance num*er thatwas running on the client.

' '

Server name s>computername

-he name of the server on which the log file entr3was generated.

' '

"in2 status sc>win2>status

-he "indows status code. ' '

03tes sent sc>*3tes -he num*er of *3tes sent *3 the server. ' '

03tes received cs>*3tes -he num*er of *3tes received *3 the server. ' '

Protocol version cs>version -he protocol versionJF--P or -PJthat the clientused.

' '

Coo#ie cs8Coo#ie9 -he content of the coo#ie sent or received; if an3. ' '

eferrer cs8eferrer9 -he site that the user last visited. -his site provided alin# to the re6uested site.

' '

If the IIS logs are missing re6uired fields; 3ou can manuall3 configure IIS to add the fields. If 3ou choose not to add there6uired fields; some reports will not *e complete. red circle with an e&clamation point will appear at the top of theConsolidated )ogs /iew pane if the collected logs are incomplete. ?ou can chec# the SPDiag trace log in the SPDiaginstallation folder 8*3 default; C@EProgram ilesE<icrosoftESPdministration-ool#itESharePoint DiagnosticsESPDiag.log9 formore information.

Configuring the S() Server proect data*ase



SPDiag uses a S() Server 2::5 or S() Server 2::! data*ase as a repositor3 for collected data. lthough 3ou can use thesame S() Server data*ase used *3 the SharePoint farm; we recommend 3ou do so onl3 if 3ou are certain the server hassufficient resources; or 3ou are using SPDiag during off>pea# hours.

1ach logical proect has a single proect data*ase that can contain up to seven da3s of data. In large farm environments; thiscan represent a large volume of data; and the collection and retrieval processes can ta#e hours and consume significantresources on the proect data*ase and on the networ# *etween the SPDiag tool and the proect data*ase server. or thisreason; 3ou should emplo3 a separate data*ase server for use as an SPDiag proect data repositor3; unless the farmGsdata*ase server has the capacit3 to handle the e&tra load without causing performance issues for farm users.

-he SPDiag user must have create permissions on the proect data*ase server instance. "hen a new proect is created inSPDiag; a new proect data*ase is automaticall3 created on the data*ase server in the conte&t of the userGs domainaccount.

If 3ou are planning to create SPDiag proect data*ases on a data*ase server in a different domain than 3our user account;or if ctive Director3 is not used in 3our environment; ensure that 3our account has the appropriate privileges to authenticateto the S() Server data*ase.

-o download a trial version of S() Server 2::5; see Download S() Server 2::5 -rial Software [email protected]#AB)in#Id%4%4!59.

Using SPDiag

SPDiag is a tool used to collect; filter; and displa3 data from a SharePoint farm for trou*leshooting purposes. SPDiag is aread>onl3 tool; and cannot ma#e an3 changes to a farm. ?ou can use SPDiag to help 3ou to identif3 pro*lems 3ourself; or asa wa3 to collect the data needed *3 support personnel to help trou*leshoot 3our farm.

-he information in this section will help 3ou understand how to create proects; filter; and collect dataK generate graphs andreportsK and e&port data to a file.

Important:

-he user running SPDiag must have "indows server administrator rights on all servers in the farm; as well as SharePointfarm administrator rights. -hese are the same permissions re6uired to perform administrative tas#s; such as runningStsadm commands. "e recommend using an e&isting administrator account rather than creating a new one. unningSPDiag with insufficient permissions might result in incomplete data collection; as well as slow performance.

Using SPDiag to trou*leshoot a farm involves the following general steps@

%. Creating a new proect.

2. 1nsuring that log files and performance counter files are availa*le for each farm server; and noting log file locationsfor each farm server.

. Selecting a dateAtime range for the data 3ou want to anal3e.

4. Selecting the performance counters and log files for anal3sis.

5. Collect ing data from the farm servers.

L. Displa3ing data in performance counter graphs and custom reports.

7. 1&porting data to *e anal3ed *3 consultants or support personnel.

Creating a new proect n SPDiag proect consists of a collection of data representing up to seven consecutive da3s of IIS; U)S and event logs;and performance counter log data. proect is stored in a S() Server data*ase on a data*ase server that 3ou specif3. proect can *e saved indefinitel3; and data in the proect can *e reused man3 times to create snapshots and reports *asedon different sets of data stored in the proect data*ase.

-o create a new proect in SPDiag; use the following procedure.







Create a new pro,ect%. ,n the File menu; clic# New Pro,ect.

2. In the New Pro,ect dialog *o&; in the 'ata#ase Server field; t3pe the name of the data*ase server on which 3ouwant to store the proect in the format MservernameEdata*ase instanceN.

. In the Pro,ect Name field; t3pe a name for the proect. -he name will *e used as the data*ase name. -he proect

name can onl3 contain alphanumeric characters and underscores.

4. In the Pro,ect 'escription field; 3ou can optionall3 enter descriptive te&t a*out the proect.

5. Clic# Create to create the proect data*ase.

L. message displa3s the following te&t; HCreating proect; this ma3 ta#e a few minutesH. Clic# O-.

Note:

"hen 3ou create a new proect; if 3ou have not properl3 configured the IIS logs on the farm "e* servers; 3ou mightreceive a warning message reading H-he following servers have missing IIS log fields that ma3 result in incompleteSPDiag reports@ Mserver name8s9NH. If 3ou see this warning message; note the names of the servers listed in the messageand see the HConfiguring IIS logsH section earlier in this document for information on how to correct the pro*lem.

"or#ing with dataSPDiag collects several different #inds of data; and amalgamates collected data in displa3s and reports. -here are twoprimar3 views in SPDiag@ Snapshot and -rends.

-he Snapshot view is displa3ed *3 default when 3ou open SPDiag. Snapshot data; which contains information a*out thelogical structure of the farm as well as details a*out the hardware and software in the farm; is collected *3 updating theSnapshot pane. Snapshot data is static once it has *een collected *3 SPDiag; and is not used in reports or graphs in the-rends pane.



Figure .: T!e Snaps!ot pane

In -rends view; SPDiag provides filters that allow 3ou to select specific data points from log files and performance counteroutput data that has *een captured on servers in the farm. -his data is useful when 3ou want to correlate data from aspecific time range in the past with o*served performance issues.



Figure /: T!e Trends pane

?ou can also use )ive Capture to collect data in real time *3 creating and running a data collector set on a target server inthe farm. -his is useful when 3ou want to o*serve the results of real time events on farm performance. or e&ample; 3oucould start a )ive Capture session and then manuall3 start a *ac#up o* on the farm to o*serve the results. See theHCollecting performance counter data using )ive CaptureH section later in this article for more information.

Important:

0efore 3ou *egin selecting data for collection; 3ou should carefull3 consider what data points are needed to trou*leshooteffectivel3; and avoid collecting data that is not useful.

SPDiag uses a S() Server data*ase as the repositor3 for collected data. 1ach logical proect is stored in a single data*asethat can contain up to seven da3s of data. SPDiag can collect performance data from IIS logs and performance counters onthe farm servers; and can also collect live data from the servers using data collector sets 3ou configure in )ive Capture.



ll captured performance counters; logs; and report data points are retrieved from the proect data*ase as needed. ,nce3ou select a specific data point to *e displa3ed for a certain timeframe; that data is stored in the proect data*ase and willnot *e collected from the farm servers again.

If 3ou wish to discard stored data; 3ou can purge the proect data*ase *3 clic#ing Purge 'ata on the 'ata menu. 03selecting the date range for data 3ou wish to purge; all data for the date range will *e removed from the proect data*ase.Data that is stored on the farm servers; such as .*lg files created *3 data collector sets; will not *e removed from the farmservers when 3ou purge data in SPDiag.

Caution:

Data collection; which ta#es place ever3 time 3ou set filter parameters; might ta#e a long time; and might significantl3impact farm performance; depending on server resource availa*ilit3 and the volume of data *eing collected. In a largefarm environment; or an environment in which networ# *andwidth or other resources are limited; data collection could ta#eseveral hours."hen 3ou *egin using SPDiag; we recommend that 3ou initiall3 collect data for a short time period so 3ou can evaluatethe performance impact of data collection on the farm servers. ?ou can then modif3 the upload speed setting on theOptions menu as needed.

ead the sections *elow for details on how to filter; collect; displa3; and e&port data.

Snapshot viewSPDiag collects information a*out the hardware; software; and logical structure of the connected farm and displa3s it in theSnapshot pane.

?ou can e&port the snapshot to an =<) file that can *e saved as a record of 3our farm configuration and topolog3; and cansupplement other trou*leshooting documentation and maintenance records.

-o update the information in the Snapshot pane; right>clic# an o*ect in the tree view pane and then clic# 0pdate. ll o*ectsunder the selected o*ect will then *e updated to reflect their current values.

Selecting and collecting data in -rends view,nce 3ou have collected data from the farm; the data points that have *een collected are rendered in their respective panesin the Trends ta*. ?ou can also select data from the collected log files and performance counters for inclusion in a customreport in the Custom eports pane. ?ou can also displa3 collected performance counter data in the Performance <onitorpane.

-he Consolidated )ogs /iew pane displa3s the contents of all collected IIS; U)S; and event log files *3 o*ect. ?ou can usethe *ottom scroll *ar to read the raw log entries in this pane.

-he Performance <onitor pane displa3s performance counter data that 3ou select in a graphical format. ?ou select the datato displa3 *3 setting a filter that e&tracts data from the collected performance counter files.

-he Custom eports pane allows 3ou to view reports that list the top sites; slow re6uests; and failed re6uests from thecollected data. ?ou can filter this data in a variet3 of useful wa3s.

Data selection and collection for trend anal3sis is done in the -rends pane; which 3ou access *3 clic#ing the Trends ta* inthe main SPDiag window.

-he master filter *ar at the top of the -rends pane governs the time frame and scope 8the "e* servers and "e*applications9 of the data that is displa3ed in all three sections of the -rends view. ?ou use the fields in the master filter *ar tospecif3 the time frame and scope for collecting data; and for displa3ing data that has alread3 *een uploaded into the proectdata*ase. fter 3ou ma#e changes to the time frame or scope; clic# the *efres! *utton to update the data displa3ed in the-rends view.

irst; on the master filter *ar; select the time frame; the servers; and the "e* applications from which 3ou want to collectdata.



Figure 1: T!e master filter #ar

Select time frame and collection scope%. In SPDiag; clic# the Trends ta*.

2. In the &nal(2ing drop>down calendar control; select the date from which to start collecting data.

Tip:

-he first time 3ou select a date in an SPDiag proect; 3ou can choose an3 date in the past. -his sets the proectGsdate range of seven consecutive da3s; *eginning at the first date 3ou chose. ,nce this date range has *een set;an3 date outside the date range will *e gra3ed out in the nal3ing calendar control. If 3ou want to anal3e datafrom another time period; 3ou must create a new SPDiag proect.

. In the From control; select the local server time at which to start collecting data.

4. In the To control; select the local server time at which to stop collecting data.

5. Clic# the S!arePoint Scope *utton to select the servers and "e* applications from which to collect data.

In the Select servers and 3e# applications dialog *o&; all servers and "e* applications in the farm are listed. llservers and "e* applications are selected *3 default. Use the chec# *o&es ne&t to each server and "e* application toselect the ones from which 3ou want to collect data.

'e&t; select log file data 3ou want to collect for the time frame and scope 3ou specified in the last procedure.



Figure 4: T!e Merged Logs Filter

Select and collect log file data%. In the Consolidated log view pane; clic# the Filter Logs *utton.

2. In the Merged Logs Filter dialog *o&; 3ou can select IIS logs; U)S logs; and event logs. "hen 3ou select an3 of

the three options; SPDiag will collect those logs inclusivel3 for the time frame and scope 3ou specified.

. ?ou can e&clude records from collection *3 defining a filter under each log t3pe. In the ide entries #ased on t!isfilter section under a given log t3pe; use the &nd5Or field to specif3 whether a filter statement is in addition to or ine&clusion of the prior filter statements; the Field name field to select the record 3ou wish to add to the filter; theOperator field to set statement operators 8such as greater than; e6uals or contains9; and use the 6alue field to specif3the value to use in the filter statement.

It is important to remem*er that the merged logs filter is e&clusionar3; and that an3 records 3ou select in a filter will *ee&cluded from data collection.



Note:

?ou can use filters to e&plicitl3 displa3 selected data *3 using negative operators. or e&ample; if 3ou haveselected IIS to collect IIS logs; 3ou can collect onl3 records specific to the client IP address %O2.%L!.:.2 *3 settingthe following filter@

• ield name@ Client IP address

• ,perator@ 'ot 16ual

• /alue@ %O2.%L!.:.2

-he use of the 'ot 16ual operator will e&clude from collection all records in which the client IP address does note6ual the specified value. ?ou can add other , statements with negative operators to the filter to e&plicitl3 viewother records.

4. Clic# O7 to collect the data 3ou have selected and close the Merged Logs Filter dialog *o&. ?ou can also clic#&ppl( if 3ou want to collect the log file data and leave the Merged Logs Filter dialog *o& open.

Note:

If 3ou clic# &ppl( to collect the selected data and then clic# O7; the data will *e collected from the farmservers again. If 3ou want to close the Merged Logs Filter dialog *o& without refreshing the data; clic#Cancel.

Tip:

In some cases; a Perfmon .*lg file might ta#e a long time to upload to the proect data*ase. -his can happenwhen the .*lg file contains a large num*er of performance counters or a large amount of data. If it is ta#ing toolong to upload a .*lg file; 3ou can use elog.e&e; a *uilt>in "indows Server tool; to resample the log file andcreate a new log file *ased on onl3 specific counters; a certain time period; or a longer sampling interval.or e&ample; 3ou could use the following command to create a new log file that contains onl3 the data for totalprocessor time@relog logfile8#lg 9c ;Processor$<Total%;= Processor Time 9o newlogfile8#lg If 3ou use elog.e&e to create a smaller .*lg file on a farm server; 3ou should move the original .*lg file to afolder that is not read *3 SPDiag. ?ou can see the folder that SPDiag uses to access farm server performancecounter data for each farm server on the Files ta*; accessi*le *3 choosing Tools and then Options.or more information on using elog.e&e; see -wo <inute Drill@ 1),.1=1 [email protected]#AB)in#Id%4%9.

'e&t; select performance counter data for the time frame and scope 3ou specified.






Figure >: T!e Performance Counter Filter? server selected

Select and collect performance counter data%. In the Performance <onitor pane; clic# the Filter Counter *utton.

2. In the Performance Counter dialog *o&; select a value from the Servers drop>down menu. ?ou can select aserver name from the menu to displa3 specific performance counters from that farm server. ?ou can also select Farm;which displa3s calculated farm>wide measurements *ased on IIS log data.

a. If 3ou selected a server from the Servers drop>down menu; a list of e&panda*le performance counter categorieswill appear in the field *elow. 1&pand a categor3 and select a performance counter from the list of availa*le

6ueries *3 clic#ing it.

*. If 3ou selected Farm from the Servers drop>down menu; an e&panda*le tree entitled S!arePoint*e+uests willappear in the field *elow. 1&pand the parent item and select a 6uer3 from the list of availa*le 6ueries *3 clic#ing it.



Figure @: T!e Performance Counter Filter? Farms selected

. Selecting a 6uer3 will open its availa*le instances in the Instances of selected o#,ect pane on the right side ofthe dialog *o&. Clic# the instance 3ou want to select.

a. If 3ou selected a server from the Servers drop>down menu; selecting a performance counter will displa3 itsavaila*le instances; which might *e different for each counter. If no instances appear in the Instances of selectedo#,ect pane; the main performance counter o*ect will *e used.

*. If 3ou selected Farm from the Servers drop>down menu; the instances <Total and <Master9Filter will *e displa3edfor each 6uer3 3ou select. Selecting the <Total instance will collect this data from all farm servers; and <Master9

Filter will collect data onl3 from the servers that are currentl3 ena*led in the SharePoint Scope on the master filter*ar.

4. ?ou can also select a color for the displa3ed data; and the scale for the displa3; and then clic# &dd. -he selectedperformance counter instance will appear in the Performance <onitor pane.

epeat this step for each performance monitor counter 3ou wish to add to the displa3.

5. "hen 3ou have selected and added all the performance counter instances 3ou want to collect; clic# O7 to collectthe data from the farm.

Note:

If an3 of the data 3ou selected has alread3 *een collected; SPDiag will displa3 the collected data rather than collecting itagain from the farm.

?ou can modif3 the performance counter displa3 *3 hiding counters. In the list of displa3ed counters; clear the chec# *o& inthe S!ow column for the counter 3ou want to hide. Select the chec# *o& to add the counter to the displa3 again.

?ou can also remove the counter from the displa3 permanentl3 *3 clic#ing the *emove *utton for the specific counter.

Creating a custom report from collected data-he Custom eports pane allows 3ou to generate three different #inds of reports *ased on the data that has *een collectedthrough the filters in the Consolidated )ogs pane and the Performance <onitor pane. ?ou can create the following t3pes ofcustom report@



• -op Sites report; which lists the most accessed sites in the farm for the time period for which data has *een

collected.

• Slow re6uests report; which lists the re6uests with the longest response times.

• ailed re6uests report; which lists all re6uests that were not responded to *3 the farm.

Note:

-he Custom eports filter allows 3ou to select from previousl3 collected data in the proect data*ase. It does not collectnew data from the farm servers. ?ou must collect log data using the filter in the Consolidated )ogs /iew pane *efore 3oucan generate a custom report.

?ou can filter data for 3our report *3 using the Custom eports ilter. -he filter parameters are persistent *etween uses ofthe Custom *eport Filter dialog *o& within an SPDiag proect; so when 3ou close a proect in SPDiag and then reopen it;the filter parameters 3ou had previousl3 defined will appear when 3ou open the filter again.

Figure A: T!e Custom *eports Filter

Filter data for a custom report%. In the -rends view; in the Custom *eports pane; clic# the Filter *eports *utton.

2. In the Custom *eports Filter dialog *o&; select the t3pe of report 3ou want to create from the *eport T(pe drop>down menu.

. If 3ou want to create the report using all availa*le data; clic# O7 to view the report and close the Custom *eportsFilter dialog *o&; or clic# &ppl( to view the report without closing the Custom *eports Filter dialog *o&.

4. ?ou can e&clude records from the report *3 setting filter parameters. In the ide entries #ased on t!is filter section; use the &nd5Or field to specif3 whether a filter statement is in addition to or in e&clusion of the prior filterstatements; the Field name field to select the record 3ou wish to add to the filter; the Operator field to set statementoperators 8such as greater than; e6uals or contains9; and use the 6alue field to specif3 the value to use in the filterstatement.

Tip:

-o remove a parameter from the filter; right>clic# an3where in the row and clic# 'elete.

5. It is important to remem*er that; li#e the <erged )ogs filter; the Custom eports filter is e&clusionar3; and an3records 3ou select in a filter will *e e&cluded from the report.



Note:

?ou can use filters to e&plicitl3 select data *3 using negative operators. or e&ample; if 3ou have selected the ost field inthe ield 'ame column; 3ou can collect onl3 records specific to the host S1/1% *3 setting the following filter@

• ield name@ Fost

• ,perator@ 'ot 16ual

• /alue@ S1/1%

-he use of the 'ot 16ual operator will e&clude from the report all records in which the host name does not e6ual the

specified value. ?ou can add other , statements with negative operators to the filter to e&plicitl3 view other records.

L. Clic# O7 to create the report and close the Custom *eports Filter dialog *o&. ?ou can also clic# &ppl( if 3ouwant to create the report and leave the Custom *eports Filter dialog *o& open.

?ou can now view the report in the Custom eport pane.

Collecting performance counter data *3 using )ive CaptureIn addition to collecting data from logs and performance counter files; SPDiag can also capture on>demand performancecounter information *3 using )ive Capture. -he SPDiag )ive Capture feature allows 3ou to create a data collector set on thetarget server to record real>time performance counter data.

fter the data collector set 3ou created has *een run on the target server; 3ou can use the filter in the Performance <onitorpane to select and collect data from the data collector set. -he )ive Capture feature does not collect an3 data itself; *ut onl3allows 3ou to create a collector set to generate a data file on the target server.

Note:

,nl3 one data collector set at a time can *e created on a single server.



Figure B: T!e Live Capture Filter

-o collect data using )ive Capture; follow the procedure *elow.

Create a data collector set using Live Capture%. ,n the 'ata menu; clic# Live Capture.

2. In the Live Capture dialog *o&; in the Servers drop>down menu; select the farm server from which 3ou want tocapture data.

. ,nce 3ou have selected a server; a list of availa*le performance counters appears in the field *elow. Select acounter that 3ou want to capture; and clic# the &dd *utton.



'ote that some counters have multiple instances; which will appear in the Instances of selected o#,ect field when thecounter is selected. In this case; select the desired instance from that list and clic# the &dd *utton. epeat this processfor each instance 3ou want to add.

4. fter 3ou have added all the performance counter instances 3ou want to capture; in the Capture Options section;set the Sample Interval to the num*er of seconds *etween samples. -he default is five seconds.

Caution:If 3ou select a smaller sample interval; a larger volume of data will *e collected for the time frame 3ou specified; and willta#e longer to collect.

5. In the Capture counters #etween section; use the top row of date and time fields to set the start time and date for the )ive Capture; and the *ottom row of date and time fields for the end time and date. -hese settings represent thelocal dates and times on the server.

L. If 3ou want to overwrite a )ive Capture that might *e currentl3 running on the target server; 3ou can leave the*eplace a currentl( running Live Capture on t!at server wit! t!is new definition chec# *o& selected.

7. Clic# Create to create and run the data collector set on the target server.

!. Clic# Close to close the Live Capture dialog *o&.

-he data collector set 3ou created will generate a .*lg file that contains the output of the performance counters 3ouspecified. -his data will then *e availa*le for collection through the Performance <onitor filter.

?ou can also manuall3 start; stop; and delete the last collector set 3ou created on a farm server. -his is useful if; fore&ample; 3ou wish to stop and restart a running collector set. 'ote; however; that 3ou cannot start an e&pired collector set. If 3ou want to run a collector set with the same counters as an e&pired set; 3ou must create a new collector set; or simpl3leave the Live Capture dialog *o& open if 3ou want to consecutivel3 run several instances of the same collector set.

Start? stop? or delete a collector set%. ,n the 'ata menu; clic# Live Capture.

2. In the Collector Sets section at the *ottom of the Live Capture dialog *o&; select the target server from theServers drop>down menu.

. -o start the last collector set 3ou created; clic# Start.

-o stop the last collector set 3ou created; clic# Stop.

-o delete the last collector set 3ou created; clic# 'elete; then clic# es in the dialog *o& that appears.

4. Clic# Close to close the Live Capture dialog *o&.

Note:

?ou cannot edit an e&isting data collector set in SPDiag. If 3ou want to edit a collector set; 3ou can do so on the server onwhich it was created.

or more information a*out collector sets; see HScenario @ Create a Data Collector Set from Performance <onitorH in the -ech'etarticle Performance and elia*ilit3 <onitoring Step>*3>Step uide for "indows Server 2::! [email protected]#AB)in#Id%4%O9.

1&porting data?ou can e&port data from SPDiag in the form of reports. -he availa*le reports are Snapshot; currentl3 displa3ed graphs;currentl3 displa3ed custom report; and currentl3 displa3ed events and logs.

"hen 3ou e&port a snapshot; 3ou will *e as#ed if 3ou want to update the snapshot *efore e&porting. If the snapshot datahas not *een recentl3 updated; 3ou can clic# es to automaticall3 update the data *efore e&porting.

E"port a report%. ,n the 'ata menu; clic# E"port.







2. In the E"port *eports dialog *o&; chec# the reports 3ou want to e&port.

. In the Location field; either clic# Select folder to *rowse; or t3pe the path to the desired e&port folder.

4. Clic# E"port to e&port the files.

If 3ou are delivering the e&ported data to a third part3; 3ou can compress the file to reduce its sie using a commerciall3

availa*le data compression application. <icrosoft Customer Support can use these files to help 3ou to identif3 issues with3our SharePoint Server farm.

-he following ta*le displa3s the files that SPDiag e&ports.

File name 'escription

Snapshot.&ml Snapshot data

Counterraph.*mp -he graph rendered in the Performance <onitor pane

SelectedCounter)ist.t&t -he list of counters used to render the graph

Customeport.t&t -he current report rendered in the Custom eport pane

<erged)og.t&t -he contents of the <erged )og pane

$nown issuesead this section for information a*out #nown issues in SPDiag version %.:.

Unhandled e&ception in SPDiag when 'amed Pipes S() connection is used"hen 3ou create a new proect in SPDiag; and 3ou tr3 to create the proect data*ase on a S() Server computer that has*een configured to use named pipes instead of -CPAIP; SPDiag e&periences an unhandled e&ception. "e recommend that3ou configure the S() Server computer 3ou are using to host the proect data*ase to use -CPAIP connections.

If 3ou must use named pipes; 3ou can wor# around this issue *3 adding the prefi& np: to the pipe name in the formatnp:hostname.

Data*ase column in custom reports reads +',- /I)0)1If SPDiag is run in offline mode; the data*ase column in custom reports will read ',- /I)0)1. -his is *3 design. "henSPDiag is not connected to a SharePoint farm; this information is unavaila*le. If this condition is une&pected; chec# to *esure the farm is operational.

Installed ph3sical memor3 value in Snapshot is incorrect for virtualied SharePointservers"hen 3ou e&amine the +Installed ph3sical memor3 field in the Snapshot pane for a SharePoint server running in a virtualmachine; the value is incorrect. -here is no wor#around at this time.

Unicode characters in U)s are logged *3 IIS as 6uestion mar#s"hen Unicode characters are used in SharePoint U)s; IIS logging will convert the characters to 6uestions mar#s unlessU->! logging is ena*led in IIS; and the relevant language pac#s are installed on the computer running SharePoint Productsand -echnologies.

or more information on U->! logging in IIS; see 1na*ling U->! ormat for 'on>1nglish )anguages and Securit3 [email protected]#AB)in#Id%4%4:9.

or more information a*out installing ,ffice SharePoint Server language pac#s; see Deplo3 language pac#s 8,fficeSharePoint Server9 [email protected]#AB)in#Id%4%429. or information a*out installing "indows SharePointServices .:; see Deplo3 language pac#s 8"indows SharePoint Services9 [email protected]#AB)in#Id%4%4%9.

arm calculated performance counters are not displa3edIn order for SPDiag to calculate and displa3 arm performance counters 8such as num*er of re6uests across the farm; orre6uest response time9; 3ou must first upload the IIS logs for the desired time range *3 selecting them in the Consolidated














)ogs pane. If data from the IIS logs have not *een uploaded to the proect data*ase; SPDiag cannot calculate the data; andno results will *e displa3ed for these counters.

Data is missing for some or all of the farm serversIf an SPDiag proect is missing data even though SPDiag has *een configured correctl3; the user account 3ou are using torun SPDiag might not have sufficient permissions to access "<I data; or to cop3 log files from the target servers. <a#e surethe user account has administrative rights on all farm servers; and has *een granted administrator rights in SharePoint

Products and -echnologies.



-he information contained in this document represents the current view of <icrosoft Corporation on the issuesdiscussed as of the date of pu*lication. 0ecause <icrosoft must respond to changing mar#et conditions; itshould not *e interpreted to *e a commitment on the part of <icrosoft; and <icrosoft cannot guarantee theaccurac3 of an3 information presented after the date of pu*lication.

-his white paper is for informational purposes onl3. <IC,S,- <$1S ', "'-I1S; 1=P1SS;I<P)I1D , S--U-,?; S -, -F1 I',<-I,' I' -FIS D,CU<1'-.

Compl3ing with all applica*le cop3right laws is the responsi*ilit3 of the user. "ithout limiting the rights undercop3right; no part of this document ma3 *e reproduced; stored in or introduced into a retrieval s3stem; ortransmitted in an3 form or *3 an3 means 8electronic; mechanical; photocop3ing; recording; or otherwise9; or foran3 purpose; without the e&press written permission of <icrosoft Corporation.

<icrosoft ma3 have patents; patent applications; trademar#s; cop3rights; or other intellectual propert3 rightscovering su*ect matter in this document. 1&cept as e&pressl3 provided in an3 written license agreement from<icrosoft; the furnishing of this document does not give 3ou an3 license to these patents; trademar#s;cop3rights; or other intellectual propert3.

2::O <icrosoft Corporation. ll rights reserved.

<icrosoft; S() Server; "indows; SharePoint are either registered trademar#s or trademar#s of <icrosoft

Corporation in the United States andAor other countries.

-he names of actual companies and products mentioned herein ma3 *e the trademar#s of their respectiveowners.

share point diagnostics tool

Documents