Home
Microsoft

Announcing availability of the Page Diagnostics Tool for SharePoint

Today we’re pleased to announce availability of the Page Diagnostics Tool for SharePoint.  The Page Diagnostics Tool for SharePoint is a Chrome Browser Extension designed to help you identify potentially problematic Classic pages in SharePoint Online that may not be delivering optimal performance based on characteristics discovered about the page by the Page Diagnostics Tool. 

 

The Page Diagnostics Tool works by comparing discovered characteristics of one or more Classic pages in SharePoint Online to known best practices and provides guidance to remediating those issues to ensure you are delivering the best possible experience across these pages.  In addition to addressing performance of existing pages, the Page Diagnostics Tool can also be used to evaluate existing pages before they are published in your environment.

 

The Page Diagnostics Tool is currently available as a Chrome Browser Extension that can be downloaded directly or installed through the Chrome web store.

 

For additional information on installing and using the Page Diagnostics Tool, refer to the getting started guide https://support.office.com/en-us/article/use-the-page-diagnostics-tool-for-sharepoint-online-dbab259....  

 

The Page Diagnostic Tool also provides detailed information on a variety of characteristics useful for support and troubleshooting purposes to include the current CorrelationID, SPRequestDuration, SPIISLatency, page load time, and the current Url evaluated.  For information on how to use this information, refer to support documentation for the Page Diagnostics Tool at https://support.office.com/en-us/article/use-the-page-diagnostics-tool-for-sharepoint-online-dbab259....

 

 

The baseline rules currently evaluated by the Page Diagnostics Tool are detailed below.  Each rule has an associated “more info” link which will take you to the supporting page providing more insights on the rule.

 

PDiag.jpg

 

 

  1. Check Running as Standard User
    https://go.microsoft.com/fwlink/?linkid=873252
  2. Check Requests to SharePoint
  3. Check using CDNs
    https://go.microsoft.com/fwlink/?linkid=873250
  4. Check for Large Image Sizes
    https://go.microsoft.com/fwlink/?linkid=873251.
  5. Check for Structural Navigation
    https://go.microsoft.com/fwlink/?linkid=873247
  6. Check for CBQ WebPart (CBQ - Content by Query WebPart)
    https://go.microsoft.com/fwlink/?linkid=873245.

 

For additional information on using the Page Diagnostics Tool and in-product help, you can also use the About link in the tool to get links to the “How to use this tool”, “Tune SharePoint Online Performance”, “Third Party Notice” in addition to a link to “give feedback” which links to the tools and extensions section in User Voice.

 

About_PDiag.png

 

 

 


We look forward to your feedback as we continue to consider scenarios for future versions of the Page Diagnostics Tool for SharePoint.

14 Comments
Frequent Contributor

Great to see this tool is released. I have done some debugging in the past on classic pages that were not performing as aspected, having a dedicated tool for this sounds good!

Microsoft

Thanks @Harold van de Kamp!  Let us know if this solutions helps in future debugging efforts.

Frequent Visitor

Thanks Bill - just what our team needs right this moment. Thanks @harbars for passing on. 

Occasional Contributor

@Bill Baer Can this plugin be used for modern experience pages?

 

 Thanks 

Frequent Visitor

A version for Firefox would be nice.

Contributor

What happened to Edge? I thought MS wanted everyone to use it as the primary browser.

Microsoft

@RAJU GOLLA On Modern Pages you will receive basic diagnostic details and trace information.

Frequent Visitor

Hi @Bill Baer,

Thanks for delivering this tool, we as a SharePoint solution editor company will probably rely on it to increase performance and user feedback on custom SharePoint portals we develop. 

A quick technical feedback though, we experience conflicts when the plugin is installed because it double loads some SharePoint standard JS libraries (SP.js, SP.runtime.js and SP.publishing.js) which sometimes already are on the page/masterpage and I found two drawbacks :

- they are loaded from [the current SharePoint site]/_layouts/15/*.js rather than the CDN

- they break something when custom code is executing a SP.clientcontext query and gathering fields with some SP.Taxonomy.TaxonomyField among them. The taxonomy fields are then badly initialized and all their properties are null. 

I can confirm that if I prevent the plugin from loading SP.js and SP.runtime.js and directly use the ones previously loaded from static.sharepointonline.com CDN it works seamlessly. My advice would be to check the availability of both the namespaces registered by these JS files and call $.getscript() only if needed. 

Frequent Visitor

@Wojciech Wróblewski could you check with this extension converter ? I already used it in the past and it gives often good results. I don't think the plugin uses specific Chrome APIs and seems to be mainly based on vanilla JS.

Occasional Contributor

It's great to see a tool like this available to the community.  Thanks, Bill for making this happen.   However, I noticed that the values for SPRequestDuration & SPIISLatency are reporting as "N/A" and the page load time is a negative value.  Am I using it incorrectly?  (BTW - This was from home.aspx on a modern team site.)

2018-06-29_17-20-37.png

 

 

New Contributor

Is this only applicable for SharePoint online or on Premise versions as well?

Occasional Visitor

So, we observe same issues as Tom Castiglia mentioned above. This happens for few site collections not for all. If someone has any thoughts on this, please let me know. Thanks.

 

Pagedia.png

 

Microsoft

Thanks for the feedback. The N/A is as a result of not receiving the SPRequestDuration and SPIISLatency from the page. This is an issue on pages in team sites currently and is not an issue with the Tool.

The issue is already logged and is being investigated by the SharePoint Engineering team. It does not affect the rules processed by the tool.

The current version of the tool is designed for classic pages. 

The page load time was originally provided for informational purposes. It does not affect the rules processing but the issue regarding a negative load time is currently being investigated. 

Microsoft

@Rishi Gupta Works on-premises as well on classic pages served over HTTPS.