understanding the data-collection process in...

41
Understanding the data-collection process in SharePoint This white paper describes how to configure and collect various types of logs for troubleshooting issues that affect Microsoft SharePoint. Authors: Neeraj Rai, Nishant Shah Reviewers: Nishant Shah, Mahesh C M . Copyright and Trademarks © 2014 Microsoft Corporation. All rights reserved. Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation. For more information, see Use of Microsoft Copyrighted Content at http://www.microsoft.com/about/legal/permissions/ . Microsoft®, Internet Explorer, and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Microsoft products mentioned herein may be either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. All other trademarks are property of their respective owners.

Upload: others

Post on 03-Mar-2021

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Understanding the data-collectionprocess in SharePoint

This white paper describes how to configure and collect various types of logs for troubleshooting issues that affect Microsoft SharePoint.

Authors: Neeraj Rai, Nishant Shah

Reviewers: Nishant Shah, Mahesh C M

.

Copyright and Trademarks © 2014 Microsoft Corporation. All rights reserved.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual propertyrights covering subject matter in this document. Except as expressly provided in written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

For more information, see Use of Microsoft Copyrighted Content athttp://www.microsoft.com/about/legal/permissions/.

Microsoft®, Internet Explorer, and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Microsoft products mentioned herein may be either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. All other trademarks are property of their respective owners.

Page 2: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

ContentsULS (Unified Logging System)......................................................................................................................5

What are ULS logs in SharePoint?............................................................................................................5

When to use ULS logs..............................................................................................................................5

Event throttling....................................................................................................................................5

Event log flood protection...................................................................................................................6

How to enable and disable verbose ULS logging when you are reproducing the issue...........................7

Only verbose: ......................................................................................................................................7

For verbose extended logging:.............................................................................................................7

To create a new file:............................................................................................................................7

To set the default logging (disable verbose):.......................................................................................7

More information....................................................................................................................................7

Click here for Appendix B – ULS Viewer...................................................................................................8

Upgrade logs and PSCDiagnostics logs.........................................................................................................8

What are PSCDiagnostics logs?................................................................................................................8

What are upgrade and upgrade error logs?.............................................................................................8

Default log location .................................................................................................................................8

IIS logs..........................................................................................................................................................9

What are IIS logs?....................................................................................................................................9

When to use the IIS logs..........................................................................................................................9

How to enable and disable IIS logs..........................................................................................................9

User interface......................................................................................................................................9

Command line......................................................................................................................................9

How to find the IIS logs location?............................................................................................................9

FREB logs...................................................................................................................................................12

What are FREB logs?..............................................................................................................................12

When to use FREB logs..........................................................................................................................12

How to collect FREB logs .............................................................................................................................................................12

How to view the Failure Request log file...............................................................................................15

Performance Monitor (PerfMon)...............................................................................................................17

What is Performance Monitor?.............................................................................................................17

Page 3: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

When to use Performance Monitor.......................................................................................................17

Scenario.................................................................................................................................................17

More information..................................................................................................................................17

Click here for Appendix A – PerfMon.msc.............................................................................................18

Process Monitor (ProcMon).......................................................................................................................19

What is the Process Monitor tool?........................................................................................................19

When to use the Process Monitor tool?................................................................................................19

More information .................................................................................................................................19

Click here for Appendix C – Process Monitor.........................................................................................19

Network Monitor (NetMon)......................................................................................................................20

What is Network Monitor?....................................................................................................................20

When to use Network Monitor..............................................................................................................20

Scenario.................................................................................................................................................20

More information..................................................................................................................................20

Click here for Appendix E – Network Monitor.......................................................................................21

Fiddler........................................................................................................................................................22

What is Fiddler?.....................................................................................................................................22

When to use Fiddler..............................................................................................................................22

Scenario.................................................................................................................................................22

More information..................................................................................................................................22

Click here for Appendix F – Fiddler........................................................................................................22

SQL Profiler................................................................................................................................................23

What is SQL Profiler?.............................................................................................................................23

When to use SQL Profiler.......................................................................................................................23

Scenario.................................................................................................................................................23

Click here for Appendix D – SQL Profiler................................................................................................23

SQL PSSDiag...............................................................................................................................................24

What is PSSDiag?...................................................................................................................................24

When to use PSSDiag.............................................................................................................................24

Scenario.................................................................................................................................................24

More information..................................................................................................................................24

Debug Diagnostic tool (DebugDiag) ..........................................................................................................25

What is DebugDiag................................................................................................................................25

Page 4: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

When to use DebugDiag........................................................................................................................25

More information..................................................................................................................................25

Time Travel Tracing – TTT (aka iDNA)........................................................................................................26

What is Time Travel Tracing – TTT (aka iDNA)?......................................................................................26

When to use Time Travel Tracing – TTT (aka iDNA)...............................................................................26

Microsoft Support Diagnostic Tool (MSDT) ...............................................................................................27

What is the Microsoft Support Diagnostic Tool (MSDT)?.......................................................................27

Available SDP packages for Microsoft SharePoint Server-based servers...............................................27

Appendix A – PerfMon.msc.......................................................................................................................32

PerfMon.msc.........................................................................................................................................32

Start and configure Performance Monitor.............................................................................................32

Using LogMan.exe.................................................................................................................................33

Appendix B – ULSviewer.exe (ULS log viewer)...........................................................................................34

ULSviewer.exe (ULS log viewer).............................................................................................................34

Start and configure ULS Viewer.............................................................................................................34

Appendix C – Process Monitor (ProcMon) ................................................................................................35

ProcMon.exe..........................................................................................................................................35

Start and configure Process Monitor.....................................................................................................35

Appendix D – SQL Server Profiler...............................................................................................................37

SQL Server Profiler.................................................................................................................................37

Start and configure SQL Server Profiler.................................................................................................37

Appendix E – Network Monitor (NetMon) ................................................................................................38

Network Monitor...................................................................................................................................38

Start and configure Network Monitor...................................................................................................39

Appendix F – Fiddler..................................................................................................................................39

Fiddler....................................................................................................................................................39

Start and configure Fiddler....................................................................................................................40

Page 5: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

ULS (Unified Logging System)What are ULS logs in SharePoint? ULS stands for Unified Logging Service (ULS). This is the engine that creates a detailed trace output of the events that occur in SharePoint. ULS is dependent on the SharePoint 2010 Tracing service in Windows. By default, SharePoint creates ULS log files in the following locations, depending on the version of SharePoint that you’re running: SharePoint 2007: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\LOGS SharePoint 2010: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\LOGS SharePoint 2013: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\LOGS These log files are written by SharePoint in real time, and they contain information about event logging. The details and verbosity of these logs depend on their specific configuration in Central Administration.

When to use ULS logsCorrelation IDsWhen an exception occurs, the Correlation ID is displayed on the page (see the following screen shot). After you have that ID, you can use it to filter the ULS logs.

Event throttlingIn SharePoint 2010 and SharePoint 2013, you can easily revert modified settings back to the default settings. Typically, these options are modified when you are troubleshooting an issue on a specific component. Here’s what the new UI looks like:

Page 6: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Event log flood protection

This feature, as its name implies, prevents the event log from being flooded with duplicate events. This is just good practice to follow. There is also a new option to restrict the log files by file size.

Page 7: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

How to enable and disable verbose ULS logging when you are reproducing the issue Only verbose:

Open the SharePoint PowerShell console, and then run the following command to enable verbose logging: Set-SPLogLevel -EventSeverity verbose -TraceSeverity verbose -EventSeverity -Verbose For verbose extended logging: Set-SPLogLevel -EventSeverity verbose -TraceSeverity verboseex -EventSeverity -Verbose To create a new file: new-splogfile To set the default logging (disable verbose): Clear-SPLogLevel

Note: It’s important to disable verbose logging after you’ve captured the required logs.

More informationConfigure diagnostic logging (SharePoint Server 2010): http://technet.microsoft.com/en-us/library/ee748656(v=office.14).aspx Configure diagnostic logging in SharePoint 2013: http://technet.microsoft.com/en-us/library/ee748656.aspx

Page 8: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Click here for Appendix B – ULS Viewer

Upgrade logs and PSCDiagnostics logs

What are PSCDiagnostics logs?PSCDiagnostics logs are post-setup configuration diagnostic files. Each time that you open SharePoint’s central administration page, a new PSCDiagnostics file is created. These files are always stored in the same directory as the trace logs. Therefore, if you change the trace log location, these logs will follow.

Logs are in PSCDiagnostics_MM_DD_YYYY_HH_MM_SS_SSS_randomnumber.log format.

Example:

PSCDiagnostics_2_10_2014_11_50_27_548_1425714660.log

These logs are used and analyzed during installation, patching, upgrade, and SharePoint Configuration Wizard problems.

What are upgrade and upgrade error logs?Upgrade status indicators and log files should give you an indication of what went wrong during the upgrade process. We recommend that you carefully review all the errors that are logged in the upgrade log files. Warnings might not always indicate an issue, but you should review them all to determine whether any of them are likely to cause even more issues.

Logs are in the Upgrade-DATE[YYYYMMDD]-TIME[HHMMSS-SSS].log format.

The upgrade error log file combines errors and warnings into a shorter file and is named Upgrade-DATE[YYYYMMDD]-TIME[HHMMSS-SSS]-error.logs.

Examples:

Upgrade-20141009-115041-392.log

Upgrade-20141009-115041-392-error.log

Default log location In SharePoint 2007: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\LOGS In SharePoint 2010: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\LOGS In SharePoint 2013: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\LOGS

Page 9: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

IIS logsWhat are IIS logs?IIS logs provides information about demographics and usage of the IIS web server. By tracking usage data, web providers can better tailor their services to support specific regions, time frames, or IP ranges.Log filters also let providers track only the data that they deem necessary for analysis.

When to use the IIS logsEnable logging for a server when you want IIS to selectively log only certain requests to a server, based on configured criteria. As soon as server logging is enabled, you can enable selective logging for any site on the server. You can also then view the log file to see which requests are failing and which requests are succeeding.

These log file formats provide information about a range of websites and specific statistics, including Internet Protocol (IP) addresses, user information, site visits, dates, times, and queries.

How to enable and disable IIS logsTo enable or disable logging

You can perform this procedure through the user interface (UI) by running Appcmd.exe commands in a command-line window, by editing configuration files directly, or by writing WMI scripts.

User interfaceTo use the UI:

1. Open IIS Manager, and then navigate to the level that you want to manage. For information about how to start IIS Manager, see Open IIS Manager (IIS 7). For information about navigating to locations in the UI, see Navigation in IIS Manager (IIS 7).

2. In Features View, double-click Logging.

3. On the Logging page, click Enable in the Actions pane to enable logging, or click Disable to disable logging.

Command lineTo enable logging, use the following syntax:

appcmd set config /section:httpLogging /dontLog:False

To disable logging, use the following syntax:

appcmd set config /section:httpLogging /dontLog:True

How to find the IIS logs location?1. To open IIS Manager, click Start, click Run, type Inetmgr, and then click OK.

Page 10: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

2. Click the server name. In the details pane (on the right), notice the Logging option.

3. Double-click the Logging option, and then on the next screen, you see the IIS log file details.

Page 11: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

4. If you want to see the IIS logs for a specific website, you need the ID for that website.

Page 12: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

FREB logs

What are FREB logs?Failed Requests Tracing (FREB) logs—formerly known as Failed Request Event Buffering logs—comprise one of the best features that was included with IIS 7, and one that is very useful during troubleshooting. FREB logs request based tracing, and this produces a log file (in .xml format) that shows events and notifications from the various modules that worked on the request during its life cycle.

When to use FREB logsYou typically use FREB logs when you encounter a specific http error code while you’re trying to access asite. For example: “400.0 bad Request.”

How to collect FREB logs

1. To start IIS Manager, click Start, click Run, type Inetmgr, and then click OK.

2. Select the problematic site.

3. Double-click Failed Requests.

Page 13: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

4. Click Edit Site Tracing, and then select the Enable check box.

Note: The location where the log file will be stored is also mentioned in the preceding screen shot.

5. Click OK.

6. Right-click to generate the shortcut menu, and then click Add.

Page 14: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

7. Select the file type that you want to trace (also notice the All Content option), and then click Next.

8. Enter the status code that you are receiving. For example: 500, 403, or 400.0.

Page 15: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

9. Click Finish.

How to view the Failure Request log fileIf you receive an HTTP response code of 404.2 when you try to access the http://localhost/ site, use the following procedure to view the FREB logs.

1. Because you have already generated a failed request, open a command prompt with administrator user rights, and then navigate to the following location:

%systemdrive%\inetpub\logs\FailedReqLogFiles\W3SVC1

Notice that when IIS writes the failed request log file, it writes one file per failed request. One Freb.xsl style sheet is also written per directory. This style sheet helps when you view the resulting failure request log files (such as fr000001.xml from the preceding screen shot).

2. Right-click the log file for the 404.2 error, click Open with, and then click Internet Explorer. If this is the first time that you are opening a Failed Request Tracing file, you must add

Page 16: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

about:internet to the list of trusted sites, because Internet Explorer's Enhanced Security Configuration is enabled by default. If this is the case, you will see the following:

3. In the Internet Explorer dialog box, click Add to add about:internet to the list of trusted sites. This enables the XSL style sheet. After you add about:internet to the list of trusted sites, you seethe following:

Page 17: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Performance Monitor (PerfMon)What is Performance Monitor?Overall system performance might be limited by the access speed of the physical hard disks, the amountof memory available to running processes, the top speed of the processor, or the maximum throughput of the network interfaces. You can use Performance Monitor to identify such bottlenecks.

Performance Monitor is a simple yet powerful visualization tool for viewing performance data, both in real time and from log files for later analysis. By using it, you can examine performance data in a graph, a histogram, or a report. You can use Performance Monitor to determine how the programs that you run affect your computer's performance.

When to use Performance MonitorYou can use Performance Monitor to troubleshoot any performance-related issues when you suspect a bottleneck. It is also useful for detecting potential memory leaks, thread leaks, and handle leaks. There are more than 60 basic performance objects, and each object contains multiple counters. These counters reveal the vital signs of a server or an application. There are five major resource areas that can cause bottlenecks and that may affect server performance: Physical Disk, Memory, CPU, Network, and Process. If any of these resources are over-used, the performance of your server or application may decrease.The Baseline and Incident performance counters are also important, as follows:

The Baseline counter provides a critical reference point and is determined during a normal workload over a specified period of time. Baseline is generally captured for 24 hours (or during business hours only) when the system or application is functioning in the expected manner and under a normal load.

The Incident counter data is generally captured for a period of 15–20 minutes (based on the duration of the issue) when the system or application is functioning in an unexpected manner.

Note: Port 445 must be open to connect Performance Monitor to the remote server.

Scenario1) There is a significant load on SharePoint sites during normal business hours (or during a load

test), and the site browse performance is slow.

2) Index and Crawl performance is slower than what was previously benchmarked.

3) Site browse requests time out after you wait for several seconds or minutes.

4) You monitor real-time performance by using various counters and objects to identify CPU, Memory, Disk, and Network-level bottlenecks for a particular server.

More information http://technet.microsoft.com/en-us/library/cc749249.aspx

http://technet.microsoft.com/en-us/magazine/2008.08.pulse.aspx

http://technet.microsoft.com/en-us/library/dd744567.aspx

Page 18: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Click here for Appendix A – PerfMon.msc.

Page 19: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Process Monitor (ProcMon)

What is the Process Monitor tool?Process Monitor is an advanced monitoring tool for Windows that shows real-time file system, registry, and process/thread activity. Process Monitor combines the features of two legacy Sysinternals utilities, FileMon and RegMon, and it adds an extensive list of improvements. These include rich and nondestructive filtering, comprehensive event properties such as session IDs and user names, reliable process information, full thread stacks with integrated symbol support for each operation, and concurrent logging to a file. Its powerful features will make Process Monitor a core utility in your system troubleshooting and malware-hunting toolkit.Process Monitor includes powerful monitoring and filtering capabilities. These include the following:

The ability to capture more data for operation input and output parameters Nondestructive filters that let you set filters without losing data The capture of thread stacks for each operation that frequently make it possible to identify the

cause of an operation The reliable capture of process details that include image path, command line, and user and

session ID Configurable and movable columns for any event property Filters that can be set for any data field, including fields that are not configured as columns Advanced logging architecture that scales to tens of millions of captured events and gigabytes of

log data A process-tree tool that shows the relationship of processes that are referenced in a trace A native log format that preserves data for loading in a different instance of Process Monitor A process tooltip for easy viewing of process image information A detail tooltip that enables convenient access to formatted data that doesn't fit in the column Cancelable search Startup time logging of operations

When to use the Process Monitor tool?Process Monitor is very helpful in many situations where you need to know which process, registry key, custom DLL, or OOB DLL is causing the issue. Process Monitor is also helpful in checking whether there any permissions issues on the server.

More information Download link: http://technet.microsoft.com/en-in/sysinternals/bb896645.aspx

Click here for Appendix C – Process Monitor

Page 20: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Network Monitor (NetMon)What is Network Monitor?Microsoft Network Monitor is a GUI packet analyzer. It lets you capture, view, and analyze network data, and if necessary, decipher network protocols. Network Monitor is quite useful in troubleshooting network problems and applications on the network.

Microsoft Message Analyzer is the successor to Network Monitor.

When to use Network MonitorYou should use Network Monitor when you want to diagnose network-related issues.

If the network adapter supports p-mode (promiscuous mode), and if p-mode is enabled, the network adapter copies most of the frames that pass over the network to Capture Buffer, regardless of the destination address. In this mode, Network Monitor can capture and display all network traffic.

Network Monitor displays the following kinds of information:

The source address of the computer that sent a frame to the network

The destination address of the computer that received the frame

The protocols that were used to send the frame

The data or a part of the message that is being sent

Process names

IP, TCP, and HTTP-level conversations

Scenario Slow performance

An unresponsive webpage or server when it is accessed remotely

Packet drops

Connectivity issues

More information Download Microsoft Network Monitor 3.4 – http://www.microsoft.com/en-

in/download/details.aspx?id=4865

Download Network Monitor Experts – http://nmexperts.codeplex.com/

Download Microsoft Message Analyzer – http://www.microsoft.com/en-us/download/details.aspx?id=40308

FAQ - http://support.microsoft.com/kb/294818

Page 21: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Click here for Appendix E – Network Monitor

Page 22: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

FiddlerWhat is Fiddler?Fiddler is an HTTP debugging proxy tool that you can use for troubleshooting. Fiddler can analyze or modify HTTP traffic as it is being sent or received.

When to use Fiddler HTTP and HTTPS traffic analysis and manipulation

(The decryption of HTTPS traffic requires additional Fiddler configuration.)

Web debugging

Security and performance testing

Determining which page components took how much time during a page load

Scenario Slow loading of HTTP pages

Analyzing HTTP response

Reissuing a request unconditionally or after editing

Requesting a response from web services by using SOAP envelopes

More informationDownload Fiddler from the following Telerik website: http://www.fiddler2.com/

Click here for Appendix F – Fiddler

Page 23: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

SQL ProfilerWhat is SQL Profiler?SQL Profiler provides a GUI-to-SQL trace for monitoring an instance of the database engine or Analysis Services. You can capture and save data for each event to a file or table for later analysis. SQL Profiler shows how SQL Server resolves queries internally. This lets administrators see exactly which Transact-SQL statements or multidimensional expressions are submitted to the server and how the server accesses the database or cube to return result sets.

When to use SQL ProfilerYou can use SQL Profiler to monitor several areas of SQL Server activity. These include the following:

Analyzing and debugging SQL statements and stored procedures Monitoring slow performance Stress analysis General debugging and troubleshooting Fine-tuning indexes Auditing and reviewing security activity

Scenario Slow query execution

When you need to determine whether a certain stored procedure is being called

When you need to determine which SQL statements or batches in a sproc took the longest time

When you want to rerun a single statement from sproc to analyze the output manually

Click here for Appendix D – SQL Profiler

Page 24: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

SQL PSSDiagWhat is PSSDiag?PSSDiag is a general purpose diagnostic-collection utility to collect diagnostic data, primarily for SQL Server. When PSSDiag is deployed in full mode, it can be a superset of SQL Profiler trace.

PSSDiag consists of two main components:

The configuration application, DiagConfig.exe

The collector service, PSSDiag.exe

When to use PSSDiagYou should use PSSDiag when a Microsoft CTS or GBS engineer asks you to collect diagnostic data from SQL Server. PSSDiag is preconfigured for the customer’s environment before the tool is sent to the customer. There are full and light versions of PSSDiag. The light version doesn’t capture SQL Profiler traces. Therefore, it’s useful for systems that may not require Profiler trace collection or that may be unable to handle the additional load that the SQL Profiler collection process generates.

PSSDiag expands into the C:\PSSDIAG folder that it creates on your computer. This folder must be on a drive that has sufficient disk space to hold the data and the log files that PSSDiag is configured to capture. Also, make sure that you run PSSDiag from a local drive and not from a network share or a mapped network drive.

Scenario Slow query execution

SQL Server configuration troubleshooting

SQL Server performance troubleshooting

More information http://support.microsoft.com/kb/830232

http://technet.microsoft.com/en-us/library/aa175399(v=SQL.80).aspx

Page 25: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Debug Diagnostic tool (DebugDiag) What is DebugDiagYou can use the Debug Diagnostic tool (DebugDiag) to capture a single memory snapshot of any process at a specific time.

When to use DebugDiagYou should use DebugDiag tool only when a Microsoft CTS or GBS engineer asks you to collect memory hang events or crash dumps for analysis.

More information Download the Debug Diagnostic Tool v2.0 - http://www.microsoft.com/en-

in/download/details.aspx?id=40336

How to use the Debug Diagnostic Tool – http://msdn.microsoft.com/en-us/library/ff420662.aspx

Page 26: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Time Travel Tracing – TTT (aka iDNA)What is Time Travel Tracing – TTT (aka iDNA)?The Time Travel Tracing tool, or TTTracer.exe, is a support tool that lets you capture running-memory snapshots of a process for several seconds. This tool lets you trace the program's flow.

When to use Time Travel Tracing – TTT (aka iDNA)You should use Time Travel Tracing – TTT (aka iDNA) only when a Microsoft CTS or GBS engineer asks you to collect an iDNA trace for analysis.

Page 27: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Microsoft Support Diagnostic Tool (MSDT) What is the Microsoft Support Diagnostic Tool (MSDT)?This tool collects information to send to Microsoft Support. Microsoft Support analyzes this information and uses it to determine the resolution to any problems that you may be experiencing on your computer.

More information

Frequently asked questions about the Microsoft Support Diagnostic Tool (MSDT) when it’s used with Windows 7 or Windows Server 2008 R2: http://support.microsoft.com/kb/973559/en-us

Available SDP packages for Microsoft SharePoint Server-based servers

SDP package name Description KB Article CPG 2010 Capacity Planning

Guidelines Checker for SharePoint 2010. Checks various elements of the farm to detect instances where documented capacity and/or support limits of SharePoint are being surpassed.

2581481

FAST Search Server 2010 and FAST legacy products

The FAST SDP collects server and product specific configuration data to assist engineers in troubleshooting.

2396933

SETH 2010 The SharePoint Engineer Troubleshooting Helper(SETH 2010) performs a series of checks for common support issues on the current system.

2827335

SETH 2013 The SharePoint Engineer Troubleshooting Helper(SETH 2013) performs a series of checks for common support issues on the current system.

2793381

SharePoint 2010 Kerberos ConfigurationTroubleshooter

The SharePoint Kerberos Package performs a series of checks for common SharePoint Kerberos issues on the current

2732019

Page 28: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

system.

SharePoint 2010 Performance and Publishing Diagnostic

The SharePoint 2010 Performance and Publishing package is adiagnostic tool that checks for performance degradingscenarios in SharePointServer 2010.

2777462

SharePoint 2013 Kerberos ConfigurationTroubleshooter

The SharePoint Kerberos Package performs a series of checks for common SharePoint Kerberos issues on the current system.

2850144

SharePoint 2013 OfficeWeb Apps Troubleshooter

This package can be used to troubleshoot issues with Office Web Apps Server when used with SharePoint 2013. It can be executed on both Office Web App servers, and SharePoint 2013 Servers.

2878616

SharePoint 2013 Performance and Publishing Diagnostic

The SharePoint 2013 Performance and Publishing package is adiagnostic tool that checks for performance degradingscenarios in SharePointServer 2013.

2776818

SharePoint Access Services 2013

The SharePoint Access Services 2013 package(SPAccessServices2013) performs checks forcommon support issues related to Access Services SharePoint Server 2013.

2858697

SharePoint Administration 2010

The SharePoint Administration 2010 package performs a series of checks for common support issues.

2777962

SharePoint Administration 2013

The SharePoint Administration 2013 package performs a series of checks for common support issues.

2781042

SharePoint Online Client Troubleshooter

The SharePoint Online Client Troubleshooter performs a series of checks for SharePoint online client issues on the current system.

2847920

Page 29: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

SharePoint Online Remote Diagnostic Troubleshooter

The SharePoint Online Remote Diagnostic Troubleshooter performs a series of checks for SharePoint Online issue using Merlin.

2907681

SharePoint Performance Monitor Wizard 2007

The SharePoint Performance Wizard (2007) is a diagnostic tool that allows for the creation and executionof performance gathering data in a consistent and repeatable fashion.

2608303

SharePoint Performance Monitor Wizard 2010

The SharePoint Performance Wizard (2010) is a diagnostic tool that allows for the creation and executionof performance gathering data in a consistent and repeatable fashion.

2506823

SharePoint Performance Monitor Wizard 2013

The SharePoint Performance Wizard (2013) is a diagnostic tool that allows for the creation and executionof performance gathering data in a consistent and repeatable fashion.

2838945

SharePoint Repro Log Collector

The SharePoint Repro Log Collector is a diagnostic tool that collects all relevant logs from the timeframe in which theissue has been reproduced.

2853242

SharePoint SAML Claims Troubleshooter

This package can be used to troubleshoot SAML Claims issues with SharePoint. It canbe executed on SharePoint 2010, SharePoint 2013, and ADFS 2.0 Servers.

2907948

SharePoint Search 2010

The SharePoint Search2010 package (SPSearch2010) performs checks for common support issues related to search.

2774212

SharePoint Search 2013

The SharePoint Search2013 package (SPSearch2013) performs checks for common support issues related to search.

2780737

Page 30: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

SharePoint Web Analytics

The SharePoint Web Analytics package performs a series of checks for SharePoint Web Analytics issues.

2916970

SharePoint Workflow 2010

The SharePoint Workflow 2010 package performs a series of checks for SharePoint workflow issues.

2819007

SPSReport 2007 The SharePoint Portal Server Reporting (SPSReport 2007) Toolis utilized to gather detailed information regarding a system's current configuration. The data collected will assist the Microsoft Support Professional with fault isolation.

2597695

SPSReport 2010 The SharePoint Portal Server Reporting (SPSReport 2010) Toolis utilized to gather detailed information regarding a system's current configuration. The data collected will assist the Microsoft Support Professional with fault isolation.

2493358

SPSReport 2013 The SharePoint Portal Server Reporting (SPSReport 2013) Toolis utilized to gather detailed information regarding a system's current configuration. The data collected will assist the Microsoft Support Professional with fault isolation.

2793386

User Profile 2010 The SharePoint 2010 User Profile Configuration Troubleshooter performs a series of checks for User Profile issues on the current system.

2837390

User Profile 2013 The SharePoint 2013 User Profile Configuration Troubleshooter performs a series of checks for User Profile issues on the current system.

2837391

Page 31: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event
Page 32: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Appendix A – PerfMon.mscPerfMon.mscWindows Performance Monitor is a Microsoft Management Console (MMC) snap-in that provides tools for analyzing system performance.

Start and configure Performance MonitorClick Start, type perfmon, and then press Enter. Or, press WinKey+R, type perfmon.msc, and then press Enter.

Page 33: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Using LogMan.exeBaseline:

logman create counter Perf_Baseline -s %COMPUTERNAME% -o C:\PerfLogs\Perf_Baseline_%COMPUTERNAME%.blg -f bin -v mmddhhmm -cf WFECounterList_MOSS2007.txt -si 00:01:00 -cnf 12:00:00 -b 4/29/2009 6:00AM -u "domain\userid" *

Incident:

logman create counter Perf_Incident -s %COMPUTERNAME% -o C:\PerfLogs\Perf_Incident_%COMPUTERNAME%.blg -f bin -v mmddhhmm -cf WFECounterList_MOSS2007.txt -si 00:00:05 -max 500 -u "domain\userid" *

Page 34: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Appendix B – ULSviewer.exe (ULS log viewer)ULSviewer.exe (ULS log viewer)The ULS log files are text files that SharePoint creates in the following format:

<server_name-yyyymmdd-time>.log In the viewer, you can either watch the ULS logs in real time or open a previous log file. Download link:http://ulsviewer.codeplex.com/

Start and configure ULS ViewerTo open the logs in real time, click File, point to Open From, and then click ULS.

In the next dialog box, select the default option Use ULS feed from default log-file directory if you want to see a particular log. Then, click File, point to Open From, and click File. This defaults to the LOGSdirectory, and then you can browse the list to find the ULS log file that you want.

You can see the date and time, process, product and category, severity level, correlation, and a detailed message about each event.

Page 35: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Appendix C – Process Monitor (ProcMon) ProcMon.exeProcess Monitor is an advanced monitoring tool for Windows that displays real-time file system, registry, and process/thread activity

Start and configure Process Monitor1. Download Procmon.exe by clicking the http://download.sysinternals.com/files/ProcessMonitor.zip

link, and then unzip the file on the server.

2. Open the Procmon.exe file, and Process Monitor start capturing data.

3. The following screen shot shows a search for an access denied error.

4. Set up the filter by using ”access denied” in the ProcMon tool.

Page 36: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

5. Click Add.

6. If there are any access denied errors, they are returned by Process Monitor, as follows.

7. You can double-click the item to see additional details, as in the following screen shot.

Page 37: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Appendix D – SQL Server ProfilerSQL Server ProfilerYou can use SQL Server Profiler to create and manage traces and to analyze and replay trace results.

Start and configure SQL Server ProfilerOpen SQL Server Profiler, click New trace, and then connect to appropriate SQL instance.For SharePoint, we mostly use the TSQL_SPs template. This template targets towards stored procedures.

Page 38: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Click the Events Selection tab, and make sure that the following events are selected, as illustrated in the following screen shot (you may add additional events, depending on your requirements). Click Column Filters, and target the collection to a specific database if a single database’s operations are being investigated. You can choose to filter on DatabaseName or DatabaseID. Because DatabaseID is understood natively in SQL, it can be preferable to use this filter. When you use DatabaseName as your filter, it must be internally converted to DatabaseID, and this generates nominal overhead.

Appendix E – Network Monitor (NetMon) Network MonitorNetwork Monitor is a packet analyzer. It lets you capture, view, and analyze network data and decipher network protocols. You can use this tool to troubleshoot network problems and applications on the network.

Page 39: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Start and configure Network MonitorInstall and start Network Monitor

After you select Network, click New Capture, and then click Start to start capturing data.

Appendix F – FiddlerFiddlerFiddler is an HTTP-debugging proxy tool. It can use used to analyze or modify HTTP traffic for troubleshooting purposes as the data is being sent or received.

Page 40: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

Start and configure FiddlerInstall and start Fiddler, and then browse to the website that you want to investigate (preferably after you’ve cleared the browser cache).

You can review overall frames, select each frame, review the Request and Response headers, and view the requests and responses in a variety of different modes (the following screen shot illustrates Headers mode).

Page 41: Understanding the data-collection process in SharePointdocshare04.docshare.tips/files/27380/273806808.pdf · 2017. 2. 4. · When to use ULS logs.....5 Event throttling.....5 Event

You can view the overall request count, bytes, performance details, and the response codes summary for the session when all sessions are selected.

You can also view the transfer timeline in a GUI format. This shows how many seconds each component took to load when all sessions are selected.