Looking for a simple class to add the ability to write to the Unified Logging Service (ULS) for your SharePoint 2010 project? Then the following should provide a good starting point for you.<\/p>\n
Full source code for this example is available to download from here<\/a>.<\/p>\n First things first, create a new class library project and add a class called Logger. Also add a couple of references to your project.<\/p>\n Next, have your class inherit from the SharePoint class Microsoft.SharePoint.Administration.SPDiagnosticsServiceBase<\/em>.<\/p>\n Whenever you write an event to the ULS you have options for specifying the event identifier, category and the error level. To cater for this, create three new classes called EventId, Category and ErrorLevel.<\/p>\n Each of these classes will contain an enumeration of available options. For example, take a look at the error level class:<\/p>\n This will provide four categories to log events against. You can of course add to this enumeration as you see fit.<\/p>\n The remaining two class files should look something like the following:<\/p>\n OK, back to the Logger<\/em> class.<\/p>\n Add a constant variable to identify the diagnostics area logs will be written against.<\/p>\n Next, add a couple of constructors for the class.<\/p>\n The first constructor is parameterless and uses the current local farm instance when instantiating. For cases when you need to write to the ULS and are not running under the context of SharePoint, use the second constructor and pass in your own farm<\/a> object.<\/p>\n One method that should be overridden is ProvideAreas<\/a>. This method will return a collection of the event and trace logging categories used by this service. We will use it to ensure the custom categories defined in the CategoryId<\/em> enumeration are registered.<\/p>\n Another useful method to add to the class is the following class instance indexer:<\/p>\n This will allow you to get the SPDiagnosticsCategory<\/a> object relating to one of the category enumeration values.<\/p>\n We’ll now add a few public methods, which will be used to log events to the ULS. The first is for logging errors.<\/p>\n This method calls the base WriteTrace<\/a> method to log the error details to the ULS log.<\/p>\n It also uses a private method called getTraceSeverity<\/em> to retrieve the corresponding TraceSeverity<\/a> value.<\/p>\n The other two methods handle the logging of verbose and warning events.<\/p>\n If you want the ability to log events without having to instantiate the Logger class every time, you could add a few static methods which create a new Logger<\/em> instance each time. In the examples below, these rely on a SharePoint context existing.<\/p>\n Hopefully this is enough to get you started \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":" Looking for a simple class to add the ability to write to the Unified Logging Service (ULS) for your SharePoint 2010 project? Then the following should provide a good starting point for you. Full source code for this example is … Continue reading \n
\r\n[System.Runtime.InteropServices.GuidAttribute(\"FBAF2022-DB19-4d2b-A029-948B747A4045\")]\r\npublic class Logger : SPDiagnosticsServiceBase\r\n{\r\n}\r\n<\/pre>\n
\nBefore we start implementing the methods for this class, lets add some additional classes that will be used by the Logger class.<\/p>\n\r\npublic enum ErrorLevel\r\n{\r\n Medium = 10,\r\n High = 20,\r\n Monitorable = 30,\r\n Unexpected = 40\r\n}\r\n<\/pre>\n\r\npublic enum EventId\r\n{\r\n None = 0,\r\n Information = 100,\r\n Error = 200\r\n}\r\n\r\npublic enum CategoryId\r\n{\r\n None = 0,\r\n Error = 100,\r\n Auditing = 200,\r\n Receiver = 300,\r\n WebPart = 400\r\n}\r\n<\/pre>\n\r\nprivate const string DIAGNOSTICS_AREA_NAME = \"SharePointStu.SharePoint\";\r\n<\/pre>\n
\r\npublic Logger()\r\n : base(DIAGNOSTICS_AREA_NAME, SPFarm.Local)\r\n{\r\n}\r\n\r\npublic Logger(SPFarm farm)\r\n : base(DIAGNOSTICS_AREA_NAME, farm)\r\n{\r\n}\r\n<\/pre>\n\r\nprotected override IEnumerable
\r\npublic SPDiagnosticsCategory this[CategoryId id]\r\n{\r\n get\r\n {\r\n return Areas[DIAGNOSTICS_AREA_NAME].Categories[id.ToString()];\r\n }\r\n}\r\n<\/pre>\n\r\npublic void LogError(EventId eventId, CategoryId categoryId, ErrorLevel errorId, string infoMessage, Exception ex)\r\n{\r\n WriteTrace((uint)eventId, Areas[DIAGNOSTICS_AREA_NAME].Categories[categoryId.ToString()], getTraceSeverity(errorId), infoMessage, null);\r\n\r\n if (ex != null)\r\n {\r\n WriteTrace((uint)eventId, Areas[DIAGNOSTICS_AREA_NAME].Categories[CategoryId.Error.ToString()], getTraceSeverity(errorId), string.Concat(ex.Message, \" \", ex.StackTrace), null);\r\n }\r\n}\r\n<\/pre>\n\r\npublic void LogInfo(EventId eventId, CategoryId categoryId, string infoMessage)\r\n{\r\n WriteTrace((uint)eventId, Areas[DIAGNOSTICS_AREA_NAME].Categories[categoryId.ToString()], TraceSeverity.Verbose, infoMessage, null);\r\n}\r\n\r\npublic void LogWarning(EventId eventId, CategoryId categoryId, string infoMessage)\r\n{\r\n WriteTrace((uint)eventId, Areas[DIAGNOSTICS_AREA_NAME].Categories[categoryId.ToString()], TraceSeverity.Unexpected, infoMessage, null);\r\n}\r\n<\/pre>\n\r\npublic static void LogInfoLocal(EventId eventId, CategoryId categoryId, string infoMessage)\r\n{\r\n var logger = new Logger();\r\n logger.LogInfo(eventId, categoryId, infoMessage);\r\n}\r\n\r\npublic void LogWarningLocal(EventId eventId, CategoryId categoryId, string infoMessage)\r\n{\r\n var logger = new Logger();\r\n logger.LogWarning(eventId, categoryId, infoMessage);\r\n}\r\n\r\npublic static void LogErrorLocal(EventId eventId, CategoryId categoryId, ErrorLevel errorId, string infoMessage, Exception ex)\r\n{\r\n var logger = new Logger();\r\n logger.LogError(eventId, categoryId, errorId, infoMessage, ex);\r\n}\r\n<\/pre>\n