Configuring Enterprise Library 4.0 for Exception handling and Logging

A few weeks back, I was trying to configure Enterprise Library 4.0 for Exception handling and Logging exception into event log but was not able to find any help on internet so it took me long time to do all the configurations for handling and logging exceptions using Enterprise. Library 4.0.

Follow following steps to configure Ent. Lib 4.0 Exception Handling and Logging blocks.

Configurations:

1. Download and install Enterprise library 4.0, you can download it from here.
2. After installation go to Start -> All Programs -> Microsoft patterns & practices -> Enterprise Library 4.0 – May 2008 -> Enterprise Library configuration
   
3. A new wizard console will open then go to File ->  Open Application -> (Navigate to your SharePoint web Application web.config) and click Open button.
   
4. After loading web.config, right click on the web.config path (see screen shot) –> New -> Exception Handling Application Block
   
5. A new block Exception Handling Application Block will be added to left pan of window.
6. Right click on Exception Handling Application Block –> New –> Exception Policy
   
7. A new sub block will be added click on Exception Policy and type some meaningful name for your project in right pan of window
      
   Note: Exception Policy will change to new name you had written in this step in left pan as well. This step is the most important step, if multiple developers are working on the project you need to make sure everyone is using same name across the board otherwise you can run into issue while integration.
8. Right click on My Custom Exception Policy(left pan) –> New -> Exception Type
   
9. A new dialog window will open look for Exception and click OK button.
   
10. A new sub block Exception will be added to left pan.
11. Right click on Exception –> New –> Logging Handler
    
12. Another sub block Logging Handler will be added as well as a Logging Application Block. So left pan will looks like:
    
13. Click on Logging Handler and make following changes in Properties Pan.
14. Click on Formatter Type -> click … button (in value field)
    
15. A dialog window will open select TextExcetionFormatter then click OK
    
16. Select General in for LogCategory field.
    
17. Click on Formatted EvenLog TraceListener and change source to something more meaningful e.g. Application ABC Exception
     
    Note: This step is not important but it would be good if team uses same Source name across the board.
18. Go to File -> Save Application to save all the configurations.

Web.Config Configurations:

Note: web.config changes are required if you are using Enterprise Library with SharePoint for .Net application you can skip these steps.

1. Copy following DLLs from “C:\Program Files\Microsoft Enterprise Library 4.0 - May 2008\Bin” and paste them into your web App Bin directory or deploy into GAC.

   a. Microsoft.Practices.EnterpriseLibrary.Common.dll
   b. Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.dll
   c. Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.Logging.dll
   d. Microsoft.Practices.EnterpriseLibrary.Logging.dll
   e. Microsoft.Practices.ObjectBuilder2.dll
   f. Microsoft.Practices.Unity.dll

2. Add following safe controls in web.config

   a. <SafeControl Assembly="Microsoft.Practices.EnterpriseLibrary.Common, Version=4.0.0.0, Culture=neutral,  PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.EnterpriseLibrary.Common" TypeName="*" Safe="True" />
   b.  <SafeControl Assembly="Microsoft.Practices.ObjectBuilder2, Version=2.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.ObjectBuilder2" TypeName="*" Safe="True" />
   c.  <SafeControl Assembly="Microsoft.Practices.Unity, Version=1.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.Unity" TypeName="*" Safe="True" />
   d. <SafeControl Assembly="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling" TypeName="*" Safe="True" />
   e.  <SafeControl Assembly="Microsoft.Practices.EnterpriseLibrary.Logging, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.EnterpriseLibrary.Logging" TypeName="*" Safe="True" />
   f. <SafeControl Assembly="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.Logging, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" Namespace="Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.Logging" TypeName="*" Safe="True" />

Code:

Add following references and namespaces in your project

1. Microsoft.Practices.EnterpriseLibrary.ExceptionHandling
2. Microsoft.Practices.EnterpriseLibrary.ExceptionHandling.Logging

Note: Use Browse tab while adding reference and add above references from “<System Drive>:\Program Files\Microsoft Enterprise Library 4.0 - May 2008\Bin”

User following code snippet for exception handling:

           try

            {

//CODE   

            }

            catch (Exception ex)

            {

                bool rethrow = ExceptionPolicy.HandleException(ex, "My Custom Exception Policy");

                // Policy Name should be same as we configured in configuration step 7

                if (rethrow)

                    throw; //Throw Exception if you need to show an error message to end user otherwise no need to throw exception.

            }

            finally

            {

// Close/Dispose all objects

            }

You are all done to get benefits of Enterprise Library 4.0 – Enjoy!!!!!