Hướng dẫn sử dụng Log4Net

Trong bài viết này, mình sẽ hướng dẫn cho các bạn cách sử dụng Log4Net đơn giản.
Đây là 1 công cụ log khá mạnh, cho phép bạn cấu hình thật đơn giản trong app.config, với chế độ log messages. Ngoài ra, bạn có thể tùy biến và log message lên Azure chỉ với 1 vài dòng code.

Cài đặt và cấu hình Log4Net

Trong phần này, mình sẽ hướng dẫn bạn
  • Thêm package Log4Net.
  • Tạo file log4net config.
  • Load file config trong Visual Studio.
Trong Package Manager Console, bạn gõ lệnh:
Install-Package log4net
Version hiện tại là 2.0.8.
Tạo file log4net.config để cấu hình Log4Net. Chọn Copy Always để đảm bảo file log4net luôn luôn được copy ra folder bin.

Dưới đây là file config mẫu:

<log4net>
  <root>
    <level value="ALL" />
    <appender-ref ref="console" />
    <appender-ref ref="file" />
  </root>
  <appender name="console" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date %level %logger - %message%newline" />
    </layout>
  </appender>
  <appender name="file" type="log4net.Appender.RollingFileAppender">
    <file value="Log/console-app.log" />
    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    <appendToFile value="true" />
    <rollingStyle value="Size" />
    <maxSizeRollBackups value="5" />
    <maximumFileSize value="10MB" />
    <staticLogFileName value="true" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
    </layout>
  </appender>
</log4net>

Message sẽ được log ra Console và file.
Để Log4Net hiểu được file config, bạn cần thêm config vào file AssemblyInfo.cs.

Bạn thêm dòng:

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config")]
Trường hợp bạn không muốn tạo file log4net.config, bạn có thể thêm setting của log4net trực tiếp vào file App.config hoặc file web.config, nằm trong thẻ Configuration.

<configuration>
   <configSections>
      <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
   </configSections>

   <!-- other configurations settings here -->

</configuration>

Thực thi chương trình

Dưới đây là 2 ví dụ, từ đơn giản đến phức tạp, để bạn làm quen với thiết lập trong Log4Net.
Trước tiên, thêm đoạn code này vào file Program.cs
private static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
static void Main(string[] args)
{
 log.Info("Hello logging world!");
 Console.WriteLine("Hit enter");
 Console.ReadLine();
}

Trường hợp bạn không muốn dùng Reflection, có thể sử dụng đoạn code sau:
private static readonly log4net.ILog log = log4net.LogManager.GetLogger(typeof(Program));
Program: tên class mà bạn đang sử dụng để log message.

Basic settings: Hiển thị message ra Console Log

Tạo file log4net.config với nội dung như sau:

<log4net>
   <root>
      <level value="ALL" />
      <appender-ref ref="ConsoleAppender" />
   </root>
   <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
      <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date %level %logger - %message%newline" />
      </layout>
   </appender>
</log4net>
Giải thích:
appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender: Khai báo 1 appender mới tên là ConsoleAppender. appender-ref ref="ConsoleAppender": sử dụng ConsoleAppender cho Log4Net.
Để tìm hiểu thêm về các appender khác của Log4Net, bạn tham khảo ở: https://logging.apache.org/log4net/release/manual/introduction.html#appenders

Hiển thị message log ra Console Log và thêm logs vào File

Thay thế nội dung file log4net.config bằng đoạn code sau:

<log4net>
    <root>
       <level value="ALL" />
       <appender-ref ref="ConsoleAppender" />
       <appender-ref ref="FileAppender" />
      <appender-ref ref="file" />
    </root>
    <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
       <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%date %level %logger - %message%newline" />
       </layout>
    </appender>
    
    <appender name="FileAppender" type="log4net.Appender.RollingFileAppender">
        <file value="Log/tracelog.log" />
         <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <appendToFile value="true" />
        <rollingStyle value="Size" />
        <maxSizeRollBackups value="5" />
        <maximumFileSize value="10MB" />
        <staticLogFileName value="true" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
        </layout>
    </appender>    
 </log4net>

Tham khảo

https://stackify.com/log4net-guide-dotnet-logging/

Chúc các bạn thành công
Nhatkyhoctap's blog

No comments:

Post a Comment