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

This article describes how to usePage Diagnostic Tool for SharePointto analyze modern and classic SharePoint Online sites against a predefined set of performance criteria.

The Page Diagnostics for SharePoint tool can be installed to:

• Microsoft kant (edge ​​extension)
• besides (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 page's performance against a predefined set of rules and displays detailed information when the results of a test fall outside the baseline value. SharePoint Online administrators and designers can use the tool to troubleshoot performance issues and ensure new pages are optimized before publishing.

The Page Diagnostic Tool is designed to analyze only SharePoint site pages, not system pages such asall items.aspxorsharepoint.aspx. If you try to run the tool on a system page or another 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. Navigate to a page on the SharePoint site 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 procedure in this section works for Chrome and Microsoft Edge browsers.

1. Install the Page Diagnostics tool for SharePoint toMicrosoft kant (edge ​​extension)orbesides (Chrome Extension). Please review the user privacy policy on the store description page. When you add the tool to your browser, you will see the following permission notice.

   

   This warning exists because a page can contain content from places outside of SharePoint, depending on the web parts and customizations on the page. This means that the tool will read requests and responses when the Start button is clicked, and only for the active SharePoint tab that the tool is running on. This information is captured locally by your web browser and is available to you viaExport to JSONorExport to HARbutton on the toolnetwork trackingaba.Information is not sent or recorded by Microsoft.(The tool complies with Microsoft's Accessibility Privacy Policyher.)

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

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

   1. In Microsoft Edge, navigate toExtensionsor typeedge://extensionsin the URL bar and selectdetailsfor the extension. In extension settings, check the box forallow in InPrivate.
   2. In Chrome, navigate toExtensionsor typechrome://extensionsin the URL bar and selectdetailsfor the extension. In the extension settings, select the slider toAllow in incognito mode.

3. Navigate to the SharePoint site page in SharePoint Online that you want to review. We allow "delayed loading" of items on pages; Therefore, the tool does not stop automatically (this is designed to accommodate all page load scenarios). Select to stop collectionTo stop. Make sure the page has finished loading before you stop data collection, otherwise you will only capture a partial trace.

4. Click the button on the extension toolbarto load the tool and you will see the following extension pop-up window:

   (Video) How to use Microsoft SharePoint

   

chooseTo beginto begin collecting data for analysis.

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

   1. Oadditional resourceslink provides general guidance and details about the tool, including a link to this article.
   2. Ogive feedbacklink provides a link toCollaborate user voice and SharePoint siteswebsite.
   3. OAboutthe link includes the currently installed version of the tool and a direct link to the tool's third-party announcement.

2. OKorrelations-id, SPRequestDuration, SPIISLatency,Page load timeeURLdetails are informative and may be used for some purposes.

   

   • Korrelations-IDis an important element when working with Microsoft Support, as it allows you to collect more diagnostic data for that specific page.
   • SPRequestDurationis the time SharePoint takes to process the page. Structural navigation, large images, lots of API calls can contribute to longer durations.
   • The Hidden Spiritis the time in milliseconds it took for SharePoint Online to start loading the page. This value 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 to the time the response was received and rendered in the browser. This value is affected by many factors, including network latency, computer performance, and the time it takes the browser to load the page.
   • OURL of the page(Uniform Resource Locator) is the web address of the current page.

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

   Category	Cor	Description
   It requires attention	Red	The test result is outside the baseline value and affects page performance. Follow the guidelines for correction.
   improvement opportunities	Gul	The test result is outside the baseline value and may contribute to performance problems. Specific test criteria may apply.
   No action is required	Verde	The test result is within the test baseline value.

   

4. INnetwork trackingThe tab contains details about page creation requests and responses.

How to use the Diagnostic Tests tab

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

The test results displayed onimprovement opportunitiesorIt requires attentioncategories indicate areas that should be reviewed 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 test-related guidance. The test results displayed onNo action is requiredThe category indicates compliance with the relevant rule and does not show additional details when selected.

The information on the Diagnostic Tests tab doesn't tell you how to design pages, but it does highlight factors that can affect page performance. Some page features and customizations have an unavoidable impact on page performance and should be reviewed for possible page fixes or omissions if the impact is significant.

Results in red or yellow can also indicate web parts that update data too often. For example, company news is not updated every second, but custom web parts are often created to fetch the latest news every second instead of implementing caching elements that can improve the overall user experience. Remember that when you include 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 that it is set correctly for its intended purpose.

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

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

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

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

   

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

2. Load times for test items. In some cases, there will be no time or color indicator because the elements have already been cached by the browser. To properly test this, open the page, clear your browser's cache and clickTo beginas this will force a "cold" page load and will be a true reflection of the initial page load. This should be compared to "hot" page loading, as this 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 of the tool with its developers or a technical support person by usingEnable export to HTTP file (HAR)is the recommended approach.

   

This must be enabled before you click Start, which will enable debug mode in your browser. It will generate an HTTP Archive (HAR) file that can be accessed via 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.

Microsoft Support Engagement

We include oneMicrosoft Support Level Ressourcewhich should only be used when working directly on a support case. Use of this feature will not provide you with any benefit when used without the support team's involvement and may cause site performance to significantly slow down. There is no additional information when using this feature in the tool, as the additional information is added when signing up for the service.

No changes are visible except 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 the specific page and the active session. For this reason, this should be used sparingly and only when actively involved in support.

To enable the Microsoft Support Level feature

1. Open the Page Diagnostics tool useful for SharePoint.

2. Press on the keyboardALT-Shift-L. This will showEnable support logselection box.

3. Check the box and clickTo beginto reload the page and generate verbose logging.

   

   You should note the CorrelationID (displayed at the top of the tool) and provide it to your support representative to allow them to gather additional information about the diagnostic session.

Adjust SharePoint Online performance

Adjust Office 365 performance

Performance in the modern SharePoint experience

content delivery network

Brug Office 365 Content Delivery Network (CDN) med SharePoint Online