Back-2-Basics: Exception & Event Instrumentation in .NET
0 likes661 views
The document discusses exception and event instrumentation in .NET, highlighting the importance of logging for debugging and runtime evaluation. It explains various logging methods and the use of .NET trace listeners for efficient logging configuration and customization. Additionally, it introduces advanced logging solutions, including centralized logging systems and custom trace listeners to enhance logging capabilities.
Back-2-Basics: Exception & Event Instrumentation in .NET
- 1. Back-2-Basics: Exception & Event Instrumentation in .NET
- 2. 2
- 3. Check Out Your Local User Groups!San Diego Cloud Computing User Groupwww.azureusergroup.com/group/sandiegoazureusergroupSan Diego .NET Developers Groupwww.sddotnetdg.orgSan Diego .NET User Groupwww.sandiegodotnet.comSan Diego SQL Server User Groupwww.sdsqlug.org
- 4. Win Free Software!RulesProvide your business card (or email and name)*Indicate on the back what software you are interested inOtherwise I will pick Winners will be picked next week*Yes, most likely I’m going to send you and email about my user group (sddotnetdg.org) and or web site (dotNetTips.com)PrizesCodeRush and Refactor Pro from DevExpress (4)SecondCopy (automatic backup software) (5) *CodeIt.Right Standard from SubMain (4)*Requires mailing address and phone number
- 5. Summary5
- 6. Logging Exceptions & Events
- 7. Why Do We Need To?Debugging statements only work in debug builds and while in VSNo way to tell what applications are doing during runtimeNeed to log exceptions for evaluation by support & development teamsNeed to log other information during runtimeLog information for reporting7
- 8. Logging Methods You Use?Log to Event log?Custom text files?Custom xml files?Database?….
- 9. The .NET SolutionTrace Listeners!Easy to use from any .NET application including ASP.NET!!Extremely configurableEasy to write your own listeners
- 11. OverviewWrite informative messages about the execution of an application at run time.PhasesInstrumentation — you add trace code to your application. Tracing — the tracing code writes information to the specified target. Analysis — you evaluate the tracing information to identify and understand problems in the application.11
- 12. OverviewOutput is written to one to many listeners.Part of the Trace.Listeners collectionOutput Methods:Assert - The specified text; or, if none is specified, the Call Stack. Fail - The specified text; or, if none is specified, the Call Stack.WriteWriteIfWriteLineWriteLineIf
- 13. Out of the Box ListenersTextWriterTraceListenerWrites to the TextWriter or Steam classEventLogTraceListenerWrites to an event logEvent works with ASP.NET!DefaultTraceListenerWrites Write and WriteLine messages to the OutputDebugString and to the Debugger.Log method (debug window in VS)
- 14. Out of the Box ListenersConsoleTraceListenerWrites output to the console windowDelimitedListTraceListener Writes to the text writer in a delimited text formatXmlWriterTraceListenerWrites to xml file.
- 15. ConfigurationDone via code or application config fileTurn off/ on listenersSet trace levelsSet filters
- 16. Configuration Example<system.diagnostics> <sources> <source name="DefaultSource" switchName="DefaultSwitch"> <listeners> <add name="FileLog"/> </listeners></source></sources><switches> <add name="DefaultSwitch" value="Information" /></switches> <sharedListeners> <add name="FileLog“ type="Microsoft.VisualBasic.Logging.FileLogTraceListener, Microsoft.VisualBasic, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL“ initializeData="FileLogWriter"/> </sharedListeners></system.diagnostics>
- 18. Add custom functionality & enhance .NET listenersCustom Trace Listeners
- 19. OverviewCreate your own listeners or enhance current listenersInherit TraceListenerOverride:Write - writes the specified message to the listener.WriteLine - Writes a message to the listener.TraceEvent - Writes trace information, a message, and event information to the listener specific output.19
- 20. OverviewOverride:TraceData - Writes trace information, a data object and event information to the listener specific output.GetSupportedAttributes - Gets the custom attributes supported by the trace listener.Add to config fileIn place or in addition to the .NET listeners.20
- 21. Issues with .NET ListenersXmlWriterTraceListenerDoes not write well formed xmlCreates one huge fileWith ASP.NET it says lockedCan not move, delete etc. Can not view latest trace writesDue to flushing issuesMost other file based listeners most likely suffer from the same issues
- 22. Taking Exception & Event logging to the extreme!dotNetTips.Utility Listeners
- 23. OverviewListeners part of the dotNetTips.UtilityOpen source project available at http://codeplex.com/dotnettipsCurrent version requires .NET 3.5Fixes/ enhances .NET ListenersAdds new ListenersOutputs A LOT more debugging info!Add custom information during runtime!Built-in configuration!23
- 24. Advanced Debugging InfoVia the LogEntry classAutomatic when logging Exceptions:Tread/ Process informationDomain nameApplication informationUser informationComputer informationAuto log class and method where Exception happenedMuch more!
- 25. More on LogEntryAdd custom information into a collectionAdditional propertiesCategoryId (GUID)UserMachineNameSeveritySourceSourceVersion
- 26. Enhanced ListenersEventLogTraceListenersXmlTraceListenersFixes all issues of the .NET implementation!Writes well formed xml!Does not lock file!Creates a new file for each dayAutomatic delete of old files (configurable)
- 27. Added ListenersEmailTraceListenerEmail trace events via smtp serverWebServiceTraceListenerSends trace events to a web service methodTCPTraceListener (coming soon)Sends trace events to TCP listenersWatch events in real time!
- 28. Writing Exceptions/ EventsUse LogWriterCustom for logging Exceptions, Events and LogEntryLogging Exceptions and Events uses LogEntry under the hoodWrites to the correct log collection based on type of applicationMethodsWriteEntryMessages (events) and LogEntryWriteException
- 30. Lets Kick It Up A Notch!Centralized Logging System
- 31. The ProblemEach client/ server machine logs locallySupport has to logon to each machine to read eventsNot possible sometimes at client locationNo search capabilitiesServerServerServerLogFileLogFileLogFileServerServerServerLogFileLogFileLogFile31
- 32. The SolutionCentralized Logging SystemUses WebServerTraceListenerWrites to web service that stores events in SQL ServerSearch/View for Events via ASP.NET!Client or ServerWebServiceSQLServerASP.NET
- 34. SummaryUse TraceListeners to log Exceptions/ Events!Use my Centralized Logging SystemdotNetTips.Utility (codeplex.com/dotnettips)ASP.NET site/ database (dotNetTips.com)Also look into the Enterprise LibraryLots more then just logging
Editor's Notes
- #9: ASK AUDIENCE BEFORE SHOWING LIST.Do you have issues with file logging with ASP.NET??
- #12: Briefly discuss the difference between Debug and Tracing.When you create a distributed application, you might find it difficult to test the application in the manner in which it will be used. Few development teams have the capability to test all possible combinations of operating systems or Web browsers (including all the localized language options), or to simulate the high number of users that will access the application at the same time. Under these circumstances, you cannot test how a distributed application will respond to high volumes, different setups, and unique end-user behaviors. Also, many parts of a distributed application have no user interface with which you can interact directly or view the activity of those parts.However, you can compensate for this by enabling distributed applications to describe certain events of interest to system administrators, especially things that go wrong, by instrumenting the application — that is, by placing trace statements at strategic locations in your code. Then if something unexpected occurs at run time (for example, excessively slow response time), you can determine the likely cause.