Mini Drop-in Replacement for log4net

• Download source v1.0 - 11.59 KB
• Download minilog4net_v1.1.zip

Introduction 

This is a simple 8KB drop in replacement for complex 198KB Log4net that’s a 96% size reduction. Strange that after looking on the web for a logging solution that fitted my requirements, I couldn't find one.

Background

I have been using log4net for the past 7 years and it is undoubtedly the de-facto standard for logging in the .NET Framework environment. I am also a follower of the minimalistic philosophy, and to this end, I have created a drop in replacement for log4net which is smaller and a lot less complex.

This was done mostly for the reason of size restrictions in a project, i.e., minimizing the deployment footprint of the app and also as a review exercise.

Obviously, it does not have the feature set of the original, but 99% of the time you don't need it in my experience.

What You Get

So what this mini log4net does for you is the following:

• 200 lines of code
• Drop-in replace log4net
• Threaded logger: no blocking of main code to log messages
• Write to a text files only (you can add other destinations yourself if you need it)
• Size limit log files and roll the file names with a count number
• Date roll log files: new file for each new day
• Simple single method configuration: no XML configuration files
• Ability to log method name: *performance hit

Using the Code

You can pretty much forget about any changes to your code because it will work as is.

public class someclass
{
    log4net.ILog _log = LogManager.GetLogger(typeof(someclass));

    public void Method()
    {
       _log.Debug("hello world!");
    }
}

The only changes to your code would be in the startup routine for your application where you configure the logger, this would be where you use log4net's DOMConfigurator methods and the XML configuration files.

public static void Main()
{
   LogManager.Configure(
              //where to put the logs : folders will be automatically created
              "LOGS\\log.txt", 
               500,// limit the file sizes to 500kb, 0 = no limiting
               false); // log method call names -> performance hit if enabled

}

Points of Interest

The code is pretty straightforward given it is only 200 lines long, but there is a couple of “gotchas” that I will point out here:

• AppDomain.CurrentDomain.ProcessExit: For this function to work, you must set the thread IsBackground to True otherwise it will just ignore the process exit and continue the thread. This point took me around 4 hours and a lot of hassle to try to figure out.
• Rolling filenames: If you look at the code for implementing the rolling functionality for file names, it’s simple and dirty but it works.
• LOG format output: The log output format is hardcoded to my own preference but you can change it to what you like in the code.

• Size limit: The size limitation for files is not exact but it does the job in the least lines of code and keeps the message contiguous, so you don’t have to open before and after files to see the messages.
• Method names: If you set the showmethodnames in the Configuration function, the logger will output the method name for the function in the log file which is a great help for debugging code as it specifies the exact place of the message/error and you don’t have to do anything.

The only problem is the performance hit you get because the code does a stack trace and extracts the method name. I would not recommend using this in production code but then again if you don’t log that many messages, it doesn’t matter.

History

• Initial release: 2010/12/07 
• Update v1.1 : 2012/05/05
• uses a timer instead of a thread
• added Shutdown() for implicit closing of files
• optimized string output