Thought I’d share a class I use for performance monitoring to help identify areas of code that are causing bottlenecks or take a lengthy time to execute.<\/p>\n\n\n\n
In SharePoint we can use the SPMonitoredScope<\/em> class to wrap areas of code that we want to be monitored.<\/p>\n\n\n This will output performance logging statistics to the developer dashboard (if enabled) and to the ULS.<\/p>\n\n\n\n For general SharePoint performance logging, SPMonitoredScope<\/em> is ideal but it only logs methods calls to the SharePoint databases. The class I developed allows you to monitor any method, whether it’s SharePoint related or not. Click here<\/a> to download the performance monitoring class.<\/p>\n\n\n\n The class has the following public methods:<\/p>\n\n\n\n EnterMethodBlock EndMethodBlock LogPerformanceDetails EndMonitoring ResetMonitor An example usage of the class is:<\/p>\n\n\n Checking the output, to whereever you configure the log4net component of the class to write to, you’ll see entries similar to:<\/p>\n\n\n\n “7 ‘UpdateDatabaseClassName’ ‘UpdateDatabase’ ‘Enter’ method elapsed time: 1.0001 Overall elapsed time: 1.0001” Each performance entry writes the current thread id, (in this example it’s 7), the name of the class and method name executing and then performance time data.<\/p>\n\n\n\n So from the above, it’s easy to identify that the database update part of the UpdateDatabase method is taking 1.5 seconds to process and the processing of table rows half a second.<\/p>\n\n\n\n The above example is only monitoring a single method, whereas in the majority of cases, you’d have multiple methods being called and monitored. When doing this, add a call to EndMonitoring at the logical point where the code you want to monitor has completed.<\/p>\n\n\n Click here<\/a> to download the performance monitoring class.<\/p>\n","protected":false},"excerpt":{"rendered":" Thought I’d share a class I use for performance monitoring to help identify areas of code that are causing bottlenecks or take a lengthy time to execute. In SharePoint we can use the SPMonitoredScope class to wrap areas of code … Continue reading \nusing (new SPMonitoredScope("SharePoint Performance"))\n{\n \/\/ SharePoint related code\n \/\/\n}\n<\/pre><\/div>\n\n\n
Areas you might use the custom performance monitoring class would include calls to a custom database, web services or any potentially long running method calls.<\/p>\n\n\n\n\n\n\n\n
Call this to initiate monitoring for the current method.<\/p>\n\n\n\n
Call this to end monitoring of the current method.<\/p>\n\n\n\n
Call this to log performance details for the current execution point of the executing method.<\/p>\n\n\n\n
Call this to end monitoring and log performance details to the configured logger, effectively resets all monitoring counters for the current thread.<\/p>\n\n\n\n
Call this to end monitoring, similar to EndMonitoring but without writing anything to the configured logger.<\/p>\n\n\n\n\nprivate void UpdateDatabase()\n{\n PerformanceMonitor.EnterMethodBlock();\n \n \/\/ code that updates a custom database table\n \/\/\n \/\/\n PerformanceMonitor.LogPerformanceDetails("Post update");\n \n \/\/ Process table rows\n \/\/\n \/\/\n PerformanceMonitor.LogPerformanceDetails("Post process");\n \n PerformanceMonitor.EndMethodBlock();\n}\n<\/pre><\/div>\n\n\n
“7 ‘UpdateDatabaseClassName’ ‘UpdateDatabase’ ‘Post update’ method elapsed time: 1577.1447 Overall elapsed time: 1579.1449”
“7 ‘UpdateDatabaseClassName’ ‘UpdateDatabase’ ‘Post process’ method elapsed time: 2002.1901 Overall elapsed time: 2002.1903”
“7 ‘UpdateDatabaseClassName’ ‘UpdateDatabase’ ‘Exit’ method elapsed time: 2008.1907 Overall elapsed time: 2010.1909”<\/p>\n\n\n\n\nprivate void Process()\n{\n PerformanceMonitor.EnterMethodBlock();\n \n DataTable data = GetData();\n UpdateDatabase(data);\n \n PerformanceMonitor.EndMethodBlock();\n PerformanceMonitor.EndMonitoring();\n}\n\nprivate DataTable GetData()\n{\n PerformanceMonitor.EnterMethodBlock();\n \n DataTable data\n \/\/ populate data variable\n \/\/\n PerformanceMonitor.LogPerformanceDetails("Got data");\n \n PerformanceMonitor.EndMonitoring();\n \n return data;\n}\n\nprivate void UpdateDatabase(DataTable data)\n{\n PerformanceMonitor.EnterMethodBlock();\n \n \/\/ code that updates a custom database table\n \/\/\n \/\/\n PerformanceMonitor.LogPerformanceDetails("Post update");\n \n PerformanceMonitor.EndMonitoring();\n}\n<\/pre><\/div>\n\n\n