Hướng dẫn sử dụng Log4Net: Viết 1 appender cho Log4Net (Part 2)

Appender là gì?

Appender là 1 output cho 1 bản ghi, ví dụ như console, file, email, hoặc là database. Log4Net đã định nghĩa rất nhiều appender mà hầu như chúng ta chỉ cần khai báo và xài, không cần định nghĩa thêm. Nhưng trong 1 số trường hợp, ví dụ như bạn muốn viết 1 appender mới để sử dụng cho ServiceBus, hoặc gởi data lên EventHub thì lúc đó bạn phải viết 1 appender mới.
Trong bài viết này, mình sẽ hướng dẫn các bạn viết 1 appender mới theo cách đơn giản nhất, xuất message ra file text. Từ ví dụ này, bạn có thể phát triển thêm nhiều appender tùy theo nhu cầu.

Các bước chuẩn bị

1. Tạo 1 Class Library trong Visual Studio
2. Cài đặt package log4net
3. Tạo file Appender mới
4. Implement class log4net.Appender.AppenderSkeleton
5. Override method Append()
6. Mở project dự án mà bạn dự định xài Appender mới. Add reference tới Class Library. Sau đó bạn thêm settings vào file log4net.configure theo cú pháp
   <appender name=”…” type=”MyNamespace.MyAppender, MyAssembly”>

Tạo 1 Appender đơn giản

Tạo file Log4NetFileExtension trong project class library với nội dung như sau:

namespace Log4NetExtension
{
    public class Log4NetFileExtension : AppenderSkeleton
    {
        protected override void Append(LoggingEvent loggingEvent)
        {
            var messageLog = $"{loggingEvent.Level.DisplayName} {loggingEvent.LoggerName}: {RenderLoggingEvent(loggingEvent)}";            
            System.IO.File.WriteAllText(@"WriteText.txt", messageLog);            
        }
    }
}

Trong file log4net.config, bạn thêm mới 1 appender vừa tạo:

<log4net>
    <root>
      <level value="ALL" />
      <appender-ref ref="ConsoleAppender" />   
      <appender-ref ref="Log4NetFileExtension" />
    </root>
    <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
       <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%date %level %logger - %message%newline" />
       </layout>
    </appender>
    <appender name="Log4NetFileExtension"
  type="Log4NetExtension.Log4NetFileExtension, Log4NetExtension">
  <layout type="log4net.Layout.PatternLayout">
   <ConversionPattern value="%m" />
  </layout>
 </appender>           
 </log4net>

Chạy chương trình, bạn sẽ thấy file WriteText.txt sẽ được tạo ở thư mục bin.
Download source code: MediaFire 

Truyền parameter vào custom appender

 Ở ví dụ trên, chương trình luôn ghi file log WriteText.txt ở thư mục bin. Trường hợp bạn muốn sửa file name, cần khai báo thêm parameter trong thẻ Appender:

<param name="FileName" value="file-custom.log" />   

Bạn sửa đoạn code trong file Log4NetFileExtension như sau:

public class Log4NetFileExtension : AppenderSkeleton
{
 public string FileName { get; set; }
 protected override void Append(LoggingEvent loggingEvent)
 {
  var messageLog = $"{loggingEvent.Level.DisplayName} {loggingEvent.LoggerName}: {RenderLoggingEvent(loggingEvent)}";
  System.IO.File.WriteAllText($"{FileName}", messageLog);
 }
}

Tham khảo

http://www.alteridem.net/2008/01/10/writing-an-appender-for-log4net/ 
Chúc các bạn thành công

Nhatkyhoctap's blog