Use the Site Diagnostics Tool for SharePoint Online - Microsoft 365 Enterprise (2023)

This article describes how to use it.Page Diagnostics Tool for SharePointto analyze modern and classic SharePoint Online site pages against a predefined set of performance criteria.

Page Diagnostics for SharePoint can be installed on:

• Microsoft edge (Kantudvidlês)
• Chrome (Chrome extension)

The Page Diagnostics for SharePoint tool is a browser extension for the new Microsoft Edge (https://www.microsoft.com/edge) and Chrome browsers that parse the modern SharePoint Online portal and classic publishing sites.

The tool generates a report for each analyzed page that shows the performance of the page against a predefined set of rules and displays detailed information when the results of a test are outside the baseline. SharePoint Online administrators and designers can use the tool to troubleshoot performance issues and ensure that new pages are optimized before publishing.

The Page Diagnostics Tool is designed to only analyze SharePoint site pages, not system pages likeall items.aspxosharepoint.aspx. If you try to run the tool on a system page or any other page outside the site, you will get an error message that the tool cannot run for that type of page.

This is not a bug in the tool as there is no value in evaluating libraries or system pages. Go to a SharePoint page to use the tool. If this error occurs on a SharePoint page, check the master page to ensure that the SharePoint meta tags have not been removed.

To provide feedback on the tool, select the ellipsis in the upper-right corner of the tool and selectgive feedback.

The installation process in this section works for Chrome and Microsoft Edge browsers.

1. Install the Diagnostic Pages tool for SharePointMicrosoft edge (Kantudvidlês)oChrome (Chrome extension). Read the user protection policy on the store description page. When adding the tool to your browser, you will see the following permission message.

   

   This warning applies because a page can contain content from locations outside of SharePoint, depending on the web parts and customizations on the page. This means that the tool reads requests and responses when the Start button is clicked, and only for the active SharePoint tab the tool is running on. This information is logged locally by your web browser and is available to you viaExport to JSONoExport for HARbutton on toolnetwork monitoringaba.The information is not sent or recorded by Microsoft.(The tool complies with Microsoft's privacy policy, which is availablewhether.)

   Omanage your downloadsthe license covers the use of the toolExport to JSONFunctionality. Follow your company's privacy guidelines before sharing the JSON file outside your organization, as the results contain URLs that could be classified as PII (Personally Identifiable Information).

2. To use the tool in Incognito or InPrivate mode, follow the procedure for your browser:

   1. In Microsoft Edge, go toExtensionsor typeedge://extensionsin the URL bar and selectDetailsfor the extension. In extension settings, check the box toallowed in InPrivate.
   2. In Chrome, go toExtensionsor typechrome://extensionsin the URL bar and selectDetailsfor the extension. In the extension settings, select the slider toAllow incognito browsing.

3. Go to the SharePoint site page in SharePoint Online that you want to verify. We enable "lazy loading" of elements on pages. Therefore, the tool does not stop automatically (this is designed to accommodate all page load scenarios). Select to stop collectionhope. Make sure the page has finished loading before stopping collecting data, otherwise you will only capture a partial crawl.

4. Click the extension toolbar buttonto load the tool and the following extension popup will appear:

   (Video) Analyze and diagnose SharePoint site performance

   

to choosePrincipleto start collecting data for analysis.

1. Click the ellipses (...) in the upper right corner of the tool to find the links below:

   1. Oadditional resourcesThe link provides general instructions and details about the tool, including a link to this article.
   2. Ogive feedbacklink provides a link toSharePoint Sites and Collaboration User VoiceWeb site.
   3. OAboutthe link includes the currently installed version of the tool and a direct link to the third-party advertisement for the tool.

2. OKorrelations-id, SPrequestDuration, SPIISLlatency,Page load time, eURLDetails are informational and can be used for certain purposes.

   

   • ID-correlationsis an important item when working with Microsoft Support as it allows you to collect more diagnostic data for this page.
   • SPrequestDurationis the time that SharePoint takes to process the page. Structure navigation, large images, lots of API calls can contribute to longer duration.
   • the hidden spiritis the time in milliseconds it takes for SharePoint Online to start loading the page. This price does not include the time it takes for the web application to respond.
   • Page load timeis the total time taken by the page from the time of the request until the time the response is received and rendered to the browser. This value is affected by many factors, including network latency, computer performance, and the time it takes your browser to load the page.
   • OURL lateral(Uniform Resource Locator) is the web address of the current page.

3. Odiagnostic examsthe tab displays the analysis results in three categories.No action required,improvement opportunitieseCaution is necessary. Each test result is represented by an item in one of these categories, as described in the following table:

   Category	Cor	Description
   Caution is necessary	Red	The test result is outside the baseline value and affects page performance. Follow repair instructions.
   improvement opportunities	Gul	The test result is outside the baseline value and can contribute to performance issues. Specific criteria may apply to the test.
   No action required	Verde	The test result is within the test reference value.

   

4. EMnetwork monitoringThe tab provides details about page creation requests and responses.

How to use the Diagnostics tab

When you analyze a modern SharePoint portal page or a classic publication page with the Page Diagnostics for SharePoint tool, the results are analyzed using predefined rules that compare the results against baseline values ​​and are displayed indiagnostic examsthe tab. Rules for some tests may use different base values ​​for modern portals and classic publishing sites, depending on how specific performance characteristics differ between the two.

Test results displayed inimprovement opportunitiesoCaution is necessaryCategories indicate areas to review against best practice and can be selected to display additional information about the result. Details for each item include ato know morelink, which takes you directly to the relevant instructions regarding the test. Test results displayed inNo action requiredThe category indicates compliance with the relevant rule and does not provide further details when selected.

The information on the Diagnostics tab does not tell you how to create pages, but it does point out factors that can affect page performance. Some page features and customizations have an unavoidable impact on page performance and should be reviewed for mitigation or page removal if the impact is significant.

Results in red or yellow can also indicate web parts that update data too frequently. For example, company news is not updated every second, but custom web parts are often built to retrieve the latest news every second rather than implementing caching elements that can improve the overall user experience. Keep in mind that when including web parts on a page, there are often simple ways to reduce the performance impact by evaluating the value of each available parameter to ensure it is set correctly for its intended purpose.

How to use the Network Trace tab and how to extract a HAR file

Onetwork monitoringThe tab provides detailed information about the requests to create the page and the responses received from SharePoint.

1. Look for loading times for items highlighted in red. Each request and response is color-coded to indicate its impact on the page's overall performance, using the following latency metrics:

   • Verde: < 500ms
   • Yellow: 500-1000ms
   • Red: > 1000ms

   

   In the image above, the red element is associated with the default page. It will always show red unless the page loads in < 1000 ms (less than 1 second).

2. Loading times for test items. In some cases, there will be no indication of time or color because the information has already been cached by the browser. To verify correctly, open the page, clear your browser's cache, and clickPrincipleas it will force a "cold" page load and will be a true reflection of the original page load. This should be compared to "hot" page loading as it will also help determine which elements are cached on the page.

3. Share relevant details with others who can help investigate issues. To share the details or information in the tool with its developers or a technical support usingEnable export to HTTP file (HAR)is the recommended approach.

   

It must be enabled before you click Start, which will enable debug mode in your browser. It will create an HTTP Archive (HAR) file, which you can access through the Network Tracing tab. Click "Export to HAR" and it will download the file to your computer and you can share it properly. The file can be opened in various debugging tools such as F12 Developer Tools and Fiddler.

Working with Microsoft Support

We include aMicrosoft support level capabilitywhich should only be used when working directly on a support case. Using this feature will not benefit you when used without the involvement of the support team and may cause the performance of the site to be significantly slower. There is no additional information when using this feature in the tool as the additional information is added to the log on the service.

No changes are visible except that you will be notified that you have enabled it and your page performance will be significantly degraded with 2-3x slower performance while enabled. It will only be relevant for this page and the active session. For this reason, it should be used sparingly and only when actively involved with support.

To enable the Microsoft Support Level feature

1. Open the Diagnostic Pages tool for SharePoint.

2. Tap on your keyboardALT-Shift-L. this will showEnable support logcontrol box.

3. Select the checkbox and clickPrincipleto reload the page and generate verbose logging.

   

   You should make a note of the CorrelationID (displayed at the top of the tool) and provide it to your support agent so that they can gather additional information about the diagnostic session.

Tune SharePoint Online performance

Tune Office 365 performance

Performance in the modern SharePoint experience

Content delivery network

Use o Office 365 Content Delivery Network (CDN) para o SharePoint Online