Sử dụng Log4Net trong C#

I/ Log4net là gì?

- Log4net là một công cụ giúp người lập trình ghi lại những thông tin trong lúc chạy ứng dụng. Nó chính là một phiên bản chuyển thể từ log4j và vẫn tiếp tục được phát triển kể từ năm 2001. Trong trường hợp ứng dụng của bạn có lỗi mà vẫn không tìm được nguyên nhân, log4net có thể là vị cứu tinh để giúp bạn xác định nơi gây lỗi. Ngoài ra, Log4net còn có thể thay đổi trạng thái log lúc chương trình chạy mà không cần ngừng chương trình. Bên cạnh đó, khi sử dụng log4net sẽ không ảnh hưởng đáng kể đến performance của ứng dụng, log4net còn được thiết kế với tính flexibility rất cao, chúng ta có thể mở rộng và thêm thắt những thứ mình muốn vào thư viện log4net, chẳng hạn như cách thức log, định dạng log, …

(Các bạn có thể download source code sample ở đây)

II/ Tại sao lại sử dụng log4net – lợi ích của log4net

- Như tôi nói ở trên, có những trường hợp nếu không có log4net bạn sẽ không thể nào giải quyết được. Giả sử một ngày đẹp trời bạn kí được hợp đồng béo bở làm phần mềm cho một khách hàng lớn và khó tính. Vì là một công ty lớn nên security của họ rất cao. Khi deploy chương trình cho người ta, bạn phải hẹn trước và phải qua nhiều cửa kiểm tra nghiêm ngặt. Những máy chỉ được cài đặt chương trình bạn viết cho họ và không được cài bất cứ cái gì khác. Như vậy khi sử dụng, nếu chương trình của bạn có lỗi thì làm sao để tìm nguyên nhân? Cùng lắm thì bên khách hàng sẽ chụp màn hình lỗi hoặc email đại khái cho bạn, và với những thông tin chung chung như vậy sẽ rất khó để bạn khắc phục. Ngoài ra bạn không thể cài VS.NET 2005 lên máy khách hàng hoặc tới tận nơi để debug. Nhưng nếu có sử dụng log4net, thông tin về quá trình chạy sẽ được ghi lại trên file hoặc thậm chí email cho bạn. Khi đó bạn sẽ dễ dàng tìm hiểu giải quyết vấn đề trên, và nhanh hay chậm tùy thuộc vào bạn thêm những đoạn log cụ thể và chính xác như thế nào trong code.

- Thêm một ví dụ nữa mà tôi đã từng gặp phải, đó là một project liên quan đến Webservice. Nhóm tôi phải làm một webservice để đọc thông tin trên server và trả kết quả về phía chương trình desktop. Quá trình đọc và tính toán dữ liệu trên server khá phức tạp và qua rất nhiều bước và hầu như không thể debug được. (thực ra là có thể debug được bằng cách sử dụng remote debugger, nhưng sau này tôi mới biết). Nhờ vào log4net, tôi ghi lại những bước tính toán, giá trị các biến trong một lần gọi hàm webservice và từ đó đã fix được khá nhiều bug khó.
Dù bạn là một người kĩ tính đến cỡ nào, bạn giỏi lập trình đến mức nào thì vẫn có thể có những lúc chương trình tung những exception mà bạn không ngờ đến. Sử dụng log4net có thể giúp bạn ghi lại những lần bị lỗi như vậy và từ đó bạn sẽ có cách để fix bug. Hơn nữa cách sử dụng rất dễ và nhanh gọn lẹ thì tại sao ta lại không sử dụng chứ nhị

III/ Sử dụng như thế nào?

- Trong bài viết này, tôi sẽ giới thiệu cách sử dụng log4net cho một window application và sẽ nói đến cách config cho log4net ghi thông tin log ra file bằng một file App.config. Thực ra đối với web application thì cách sử dụng hoàn toàn tương tự. Chỉ có một số trường hợp file log của bạn không sinh ra được vì không đủ quyền. Như các bạn biết thì Web application chạy dưới 1 process bằng quyền của user ASPNET trong Windows, dó đó nếu user này không đủ quyền ghi file vào folder web của bạn thì file log tương ứng cũng có thể không được tạo ra. Nếu bạn áp dụng log4net cho trang web của mình, và thuê 1 host ở VN để đưa code lên nhưng file log không sinh ra, bạn có thể gọi điện hỗ trợ dịch vụ và nhờ họ thêm permisson cho user ASPNET quyền ghi file vào folder web của bạn.

1/ Bước 1: Hãy download version mới nhất của log4net từ website apache. và add reference vào project của bạn. Khi tôi viết bài này thì version mới nhất của log4net là 1.2.10.

[assembly: log4net.Config.XmlConfigurator(ConfigFile = "Log4netSample.exe.config", Watch = true)]   //For log4net 1.2.10.0

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

</configSections>

<log4net debug="true">
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Log4netSampleLog.txt" />
<appendToFile value="true" />
<rollingStyle value="Size" />
<maxSizeRollBackups value="10" />
<maximumFileSize value="1MB" />
<staticLogFileName value="true" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%-5p %d %5rms %-22.22c{1} %-18.18M - %m%n" />

</layout>

</appender>

<root>
<level value="DEBUG" />
<appender-ref ref="RollingLogFileAppender" />

</root>

</log4net>

<file value="Log4netSampleLog.txt">

• Thông tin log của chúng ta sẽ được ghi vào file Log4netSampleLog.txt, file này sẽ nằm ở thư mục chạy của ứng dụng, cùng cấp với file exe và file .config của chúng ta. Nếu muốn nó lưu file vào chỗ khác chúng ta có thể hardcode đường dẫn ở đây.
  

<maxsizerollbackups value="10" />

• Dữ liệu log sẽ được ghi vào file, vì ta đang sử dụng là RollingFileAppender, nên khi kích thước file vượt quá một mức nào đó thì nó sẽ đổi tên file cũ và ghi vào file mới. Tổng số lượng file tối đa sẽ là 10 và những file cũ nhất sẽ bị xóa nếu số lượng file vượt quá 10.

<maximumfilesize value="1MB">

• Kích thước file log tối đa sẽ là 1MB.

• Đây là phần khá thú vị, những text log mà chúng ta ghi ra sẽ kèm thêm một số thông tin theo như phần định dạng trong layout như ngày tháng, threadId, className, ... Các bạn có thể tùy biến phần layout này để được log output dễ nhìn nhất.

  <conversionPattern value="%-5p %d %5rms %-22.22c{1} %-18.18M - %m%n" />
<layout>

Level:

• Level mặc định sẽ là Debug cho mọi nơi có sử dụng log trong chương trình của bạn. Nghĩa là nếu bạn khai báo như hình, thì mọi chỗ bạn log đều được ghi xuống file vì level DEBUG là level thấp nhất, nhưng nếu chỗ này bạn để là ERROR thì chỉ có những log với level cao hơn hoặc bằng ERROR mới được ghi xuống file. Khi deploy chương trình cho khách hàng, thường thì chúng ta sẽ để level default là ERROR, khi sử dụng có lỗi ta sẽ yêu cầu khách hàng sử lại thành DEBUG nếu cần thiết.
  

<root>
<level value="DEBUG" />
<appender-ref ref="RollingLogFileAppender" />

</root>

private static readonly ILog logger = LogManager.GetLogger(

             System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

_logger.Debug("Muahahaha");

_logger.Error("Muahahaha");

bool isLogEnabled = _logger.IsDebugEnabled;

if (isLogEnabled)
{

_logger.Debug("Muaahahaha");

}

try
{

//Make some error here

}
catch(Exception ex)
{

_logger.Errror(ex);// Right
_logger.Errror(ex.Message);// Wrong. Because most time, the ex.Message is useless.

}

  Về trang trước    Bản in    Gửi email    Về đầu trang