Click here to Skip to main content
Click here to Skip to main content

Building a Simple Logging HTTP Module with Logging Application Block

, 21 Jul 2010 CPOL
Rate this:
Please Sign up or sign in to vote.
The article deals with an HTTP module for logging using the Logging Application Block and Enterprise Library 5 fluent configuration API.

I wanted to check how to use the fluent configuration API for the Logging Application Block in Enterprise Library 5.
So I thought to myself, why not implement it with an HTTP module and provide two examples in one post.

Using the Fluent Configuration API with Logging Application Block

I wrote an article about the fluent configuration in Enterprise Library 5 in the past. Here is how I configured the Enterprise Library container in order to use the Logging Application Block in a simple flat file scenario:

private void ConfigureEnterpriseLibraryContainer()
{
  var builder = new ConfigurationSourceBuilder();
  builder.ConfigureInstrumentation().EnableLogging();
  builder.ConfigureLogging().WithOptions
         .LogToCategoryNamed("General")
           .WithOptions
           .SetAsDefaultCategory()
           .SendTo
           .FlatFile("Log File")
           .FormatWith(new FormatterBuilder()
           .TextFormatterNamed("Textformatter"))
               .ToFile("file.log");

  var configSource = new DictionaryConfigurationSource();
  builder.UpdateConfigurationWithReplace(configSource);
  EnterpriseLibraryContainer.Current =
    EnterpriseLibraryContainer.CreateDefaultContainer(configSource);
}

Pay attention that in order to use this API, you need to add references to the following DLLs:

  • Microsoft.Practices.EnterpriseLibrary.Common
  • Microsoft.Practices.EnterpriseLibrary.Logging
  • Microsoft.Practices.ServiceLocation
  • System.Configuration

Now that we have the configuration placed in memory, we can use it in our code.

Building the HTTP Module

In order to build an HTTP module, we only need to implement the IHttpModule interface. The following is a simple LoggingHttpModule which logs details when a web request starts and when a web request ends:

using System;
using System.Web;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
using Microsoft.Practices.EnterpriseLibrary.Logging;

namespace HttpModules
{
  public class LoggingHttpModule : IHttpModule
  {
    #region Members

    private LogWriter _writer;

    #endregion

    #region IHttpModule Members

    public void Dispose()
    {
      if (_writer != null)
      {
        _writer.Dispose();
      }
    }

    public void Init(HttpApplication context)
    {
      CreateLogWriter();
      context.BeginRequest += new EventHandler(context_BeginRequest);
      context.EndRequest += new EventHandler(context_EndRequest);
    }

    private void CreateLogWriter()
    {
      ConfigureEnterpriseLibraryContainer();
      _writer = EnterpriseLibraryContainer.Current.
                  GetInstance<LogWriter>();
    }

    private void ConfigureEnterpriseLibraryContainer()
    {
      var builder = new ConfigurationSourceBuilder();
      builder.ConfigureInstrumentation().EnableLogging();
      builder.ConfigureLogging().WithOptions
             .LogToCategoryNamed("General")
               .WithOptions
               .SetAsDefaultCategory()
               .SendTo
               .FlatFile("Log File")
               .FormatWith(new FormatterBuilder()
               .TextFormatterNamed("Textformatter"))
                   .ToFile("file.log");

      var configSource = new DictionaryConfigurationSource();
      builder.UpdateConfigurationWithReplace(configSource);
      EnterpriseLibraryContainer.Current =
        EnterpriseLibraryContainer.CreateDefaultContainer(configSource);
    }

    void context_BeginRequest(object sender, EventArgs e)
    {
      _writer.Write(new LogEntry
      {
        Message = "BeginRequest"
      });
    }

    void context_EndRequest(object sender, EventArgs e)
    {
      _writer.Write(new LogEntry
      {
        Message = "EndRequest"
      });
    }

    #endregion
  }
}

Using the Module

In order to use the module, all we need to do is to add a reference to the class library that holds the LoggingHttpModule. Then we need to register the module in the web.config file in the httpModules element like:

<httpModules>
    <add name="LoggingHttpModlue"
       type="HttpModules.LoggingHttpModule, HttpModules"/>
</httpModules>

That is it. Now the module will be executed whenever a request starts or ends.

Summary

Using the fluent configuration API of Enterprise Library 5 can make it easy to configure cross cutting concerns like logging without a configuration file. The API is simple and very easy to apply. In this post, I showed how to combine the Logging Application Block within an HTTP module with the fluent configuration API.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Gil Fink
Technical Lead sparXys
Israel Israel
Gil Fink is a web development expert and ASP.Net/IIS Microsoft MVP. He is the founder and owner of sparXys. He is currently consulting for various enterprises and companies, where he helps to develop Web and RIA-based solutions. He conducts lectures and workshops for individuals and enterprises who want to specialize in infrastructure and web development. He is also co-author of several Microsoft Official Courses (MOCs) and training kits, co-author of "Pro Single Page Application Development" book (Apress) and the founder of Front-End.IL Meetup. You can read his publications at his website: http://www.gilfink.net
Follow on   Twitter   Google+   LinkedIn

Comments and Discussions

 
QuestionHow to configure and use Microsoft Enterprise Library 5 for logging PinmemberLibish Varghese Jacob17-Jul-12 21:21 
Generalunable to find ConfigureLogging Pinmemberavirami13-Dec-10 19:36 
GeneralRe: unable to find ConfigureLogging PinmemberGil Fink14-Dec-10 4:51 
GeneralRe: unable to find ConfigureLogging Pinmemberavirami14-Dec-10 21:41 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.1411023.1 | Last Updated 22 Jul 2010
Article Copyright 2010 by Gil Fink
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid