Lesson 15.2: Catch and log exceptions

To make the program easier to maintain, let’s catch all exceptions and write them to a log file.

 

 

 

Lesson Steps

Step 1: Create file Engine\Services\LoggingService.cs

This LoggingService class and functions are static. We won’t need to instantiate anything to log an exception.

Line 8 has a constant for the sub-directory where we’ll store the log files. In the future, we might move this to a config file setting.

Lines 10-18 are the static “constructor” – the function that runs the first time anything calls a function in this static class. This function checks if a “Logs” sub-directory exists under the directory where the application is currently located. If it doesn’t exist, this function will create it.

Lines 20-36 is where we write exception information to the log file. We write the exception’s Message and StackTrace values. They’re usually the most important information from an exception.

If the exception has an inner exception, we recursively call this “Log” function, passing in a “true” for the “isInnerException” parameter – which defaults to “false” when the initial exception is passed into this function.

Lines 38-44 is a small function to build the log file’s path and file name. Because we are concatenating the current date into the log file name, we’ll have a separate file for each day.

This probably isn’t needed for this program. But, it’s something I usually do in my corporate programs. If something goes wrong with a website, web service, or Windows service, it might produce hundreds or thousands of errors. So, you don’t want to only have one log file you keep writing to forever.

 

LoggingService.cs

 

 

Step 2: Modify WPFUI\App.xaml and App.xaml.cs

We could add exception-handling in many places. But, it’s usually best to only catch an exception if you can do something about it.

We’re going to put one catch-all exception handler in the program. In WPF programs, you can do that by adding a function to call for any exceptions that aren’t handled anywhere else in the program.

Line 5 of App.xaml is where we define the function to call when there is an unhandled exception. We “dispatch” that exception to “App_OnDispatcherUnhandledException”.

Lines 9-18 of App.xaml.cs are the App_OnDispatcherUnhandledException function. We pass the exception to the new LoggingService, to write its information to the log file. Then, we display the exception to the user in a MessageBox.

In the future, we might come up with a better window to display exceptions. But, it’s probably more important to focus on writing the code so it doesn’t have exceptions.

 

App.xaml

 

 

App.xaml.cs

 

Additional links for this project

Source code: https://github.com/ScottLilly/SOSCSRPG

Project plan: https://github.com/ScottLilly/SOSCSRPG/projects/1

Discord: https://discord.gg/AUYXYtH

 

Return to main page

2 thoughts on “Lesson 15.2: Catch and log exceptions

  1. For some reason this 15.2 lesson video did not show up in my YouTube feed, despite being a subscriber! The 15.1 and 15.3 videos show up. Just wanted to let you know in case there’s a setting to click when you upload. I don’t upload videos myself so I’m unfamiliar.

    1. Thanks for letting me know. It looks like everything is set up the same as the other videos. I might have missed something when I uploaded that video. So, I added a note to my video upload checklist in case I missed some sort of notification option.

      If you use Twitter, I also post on https://twitter.com/ScottLilly after each lesson upload.

Leave a Reply

Your email address will not be published. Required fields are marked *