How to enable the Developer Dashboard in SharePoint 2013

Intro

The SharePoint Developer Dashboard is a built-in tool that has been available since SharePoint 2010. It provides diagnostic information that can be used by developers and system administrators to identify and troubleshoot issues related to page components. It also makes it easier to identify performance issues and resource usage right from the current page, which is easier than analyzing raw data from the ULS logs.

This post provides some details about changes to the developer dashboard in SharePoint 2013 and a PowerShell script to enable and disable the dashboard.

Changes to Developer DashBoard in SharePoint 2013

  • In SP 2010, the Developer Dashboard was rendered as a control in the master page, and it only showed information about the current request. In SP 2013 it shows as a separate window and it shows information about all request since the dashboard was enabled
  • The dashboard depends on “Usage and Health Data Collection Service Application”. This service must have been created and it must be running, otherwise no data trace data will be displayed (see Wictor Wilén post below).
  • The dashboard can be enabled (On) and disabled (Off). See the PowerShell below for performing these two actions.
  • The following tags must be present in the master page:
<SharePoint:DeveloperDashboard runat="server" />
<SharePoint:DeveloperDashboardLauncher
    ID="DeveloperDashboardLauncher"
    ThemeKey="spcommon"
    TouchMode="true"
    TouchModeWidth="30"
    TouchModeHeight="30"
    TouchModePaddingLeft="7"
    TouchModePaddingTop="7"
    TouchModePaddingRight="7"
    TouchModePaddingBottom="7"
    NavigateUrl="#"
    OnClick="ToggleDeveloperDashboard();return false"
    OuterCssClass="ms-dd-button ms-qatbutton"
    runat="server"
    ImageUrl="/_layouts/15/images/spcommon.png"
    AlternateText="<%$Resources:wss,multipages_launchdevdashalt_text%>"
    ToolTip="<%$Resources:wss,multipages_launchdevdashalt_text%>"
    OffsetX="237"
    OffsetY="30"
    HoverOffsetX="219"
    HoverOffsetY="66"
    Height="16"
    Width="16" />

PowerShell Script

The following script can be used to enable or disable the developer dashboard in a SharePoint 2013 farm:

# Add SharePoint cmdlets reference 
Add-PSSnapin "Microsoft.SharePoint.Powershell" -ErrorAction SilentlyContinue

#Enable Dashboard
$contentSvc = [Microsoft.SharePoint.Administration.SPWebService]::ContentService
$devDahsboardSettings = $contentSvc.DeveloperDashboardSettings
$devDahsboardSettings.DisplayLevel = "On"
$devDahsboardSettings.Update()

#Disable Dashboard
$contentSvc = ([Microsoft.SharePoint.Administration.SPWebService]::ContentService)
$devDahsboardSettings =$contentSvc.DeveloperDashboardSettings
$devDahsboardSettings.DisplayLevel = [Microsoft.SharePoint.Administration.SPDeveloperDashboardLevel]::Off
$devDahsboardSettings.Update()

Summary

The SharePoint developer dashboard is a great tool to identify and troubleshoot page issues. In addition to ULSViewer, the dashboard is a great addition to the developer toolset for assisting in fine tuning custom components and ensuring good performance.

Reference

Using the Developer DashBoard (MSDN)

Developer Dashboard in SharePoint 2013

SharePoint 2013: Developer Dashboard shows no data “issue” (Wictor Wilén)

 

Advertisements

Author: Luis Carrazana

Skilled Senior Technology Consultant and Strategist, with a decade of experience advising and assisting customers from small and large companies, including Fortune 500. Luis is a Microsoft Certified Professional with extensive experience in .NET framework and SharePoint development.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s