SharePoint Diagnostics Tool (SPDiag)
Updated: August 27, 2009
Applies To: Office SharePoint Server 2007
The SharePoint Diagnostic tool (SPDiag) version 2, included with the latest release of the SharePoint Administration Toolkit, was created to simplify and standardize troubleshooting of SharePoint Products and Technologies, and to provide a unified view of collected data. SharePoint Products and Technologies administrators can use SPDiag to gather relevant information from a farm, display the results in a meaningful way, identify performance issues, and export the collected data and reports for analysis by Microsoft support personnel.
The SharePoint Products and Technologies platform is highly complex and can be used for a wide variety of uses. Deploying, managing, and troubleshooting SharePoint Products and Technologies requires extensive knowledge spanning multiple technology areas, including security, networking, such Web technologies as ASPX, and SQL Server.
Traditionally, troubleshooting SharePoint Products and Technologies involves manually collecting a wide array of data from servers in the affected farm, and then manually analyzing the data to determine the source of the problem. This process can be complex 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 Technologies Web servers, application servers and SQL servers, and store the collected data for each project in a SQL Server database for retrieval and analysis. SPDiag can collect performance data from IIS logs, ULS logs, and performance counters, and can also collect live data from the servers using Windows Management Instrumentation (WMI). Data can then be displayed in the Trends pane of the SPDiag interface and filtered to reveal trends, bottlenecks, and other performance issues that would otherwise require significant manual data processing to uncover. You can also view the individual components and the logical structure of the farm in the Snapshot pane.
SPDiag operates in the context of a project, which is the container used to store collected data for a specific farm. Each project has its own database, and you can create many projects for a single farm, subject only to database server resource limitations. Projects can be saved and reopened again at a later time, and new data can be added to a project between SPDiag sessions. You cannot move data between projects, and you cannot collect data from more than one farm in a single project. Because all SPDiag project data is stored in a SQL Server database, you can back up a project database or move it to another database server.
SPDiag can be used in online or offline modes. In online mode, SPDiag is installed on a Web server belonging to the farm you wish to troubleshoot. This allows SPDiag to connect to the farm and collect data. In offline mode, SPDiag is installed on a computer that is not a part of a farm. It can be used to review existing SPDiag projects and import log files from farm servers as a new project, but cannot collect real time data from a farm.
You can export collected data and reports as data files that can then be sent to Microsoft support technicians for analysis. This can help to facilitate remote troubleshooting by ensuring that the required data is captured on-site, and by consolidating the data in a standardized format.
SPDiag version 2 introduces advanced diagnostics functionality, using predefined rules based on the System Center Operations Manager (SCOM) model to check for your SharePoint farm’s compliance with best practices, and then display the results in the new Diagnostics pane.
SPDiag version 2 also introduces command-line data collection, offline mode data import, trend pane zoom feature, and new snapshot data points.
For more information, see What's new in SPDiag version 2.
In this chapter: