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 | SPC050253 |
---|---|
TypeName | RemovedTimerJobInstancesInFeaturedDeactivating |
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;
consoleSettings.Update();
}
}
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.
[SuppressMessage("SPCAF.Rules.BestPracticesGroup", "SPC050253:RemovedTimerJobInstancesInFeaturedDeactivating", Justification = "Provide reason for suppression here")]