Expand Minimize

Use SPMonitoredScope with Developer Dashboard, on all custom code

When enabling developer dashboard feature in SharePoint 2010, in order to get all of the custom code included in the developer dashboard output, wrap it in a monitored scope.

CheckId SPC050251
TypeName EnsureMonitoredScopeIsUsedWithDeveloperDashboard
Severity CriticalWarning
Type Assembly

Use SPMonitoredScope to wrap the code so that the performance measures for the web-part can be tracked in Developer Dashboard in SharePoint.

void GoodExampleOfUsage()
  using (new SPMonitoredScope("My Scope Name"))
    var consoleSettings = SPWebService.ContentService.DeveloperDashboardSettings;
    consoleSettings.DisplayLevel = SPDeveloperDashboardLevel.OnDemand;
    consoleSettings.RequiredPermissions = Microsoft.SharePoint.SPBasePermissions.EmptyMask;
    consoleSettings.TraceEnabled = true;

To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.

// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("SPCAF.Rules.BestPracticesGroup", "SPC050251:EnsureMonitoredScopeIsUsedWithDeveloperDashboard", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.