Logging trong ASP.NET Core

1. Tại Sao Cần Logging?

Logging cung cấp cho bạn:

• Theo dõi sự kiện: Ghi lại những hành động xảy ra trong ứng dụng, từ thông tin nhỏ nhất đến những lỗi nghiêm trọng.
• Debug & Giám sát: Phát hiện, theo dõi và sửa lỗi nhanh chóng, cải thiện hiệu suất và bảo mật.
• Phân tích hành vi người dùng: Hiểu rõ cách ứng dụng được sử dụng để tối ưu hóa trải nghiệm.

---

2. Các Khái Niệm Cơ Bản

2.1. Logging Abstraction

ASP.NET Core sử dụng namespace Microsoft.Extensions.Logging để cung cấp một lớp trừu tượng cho việc ghi log thông qua giao diện ILogger và ILoggerFactory. Điều này cho phép bạn dễ dàng chuyển đổi giữa các nhà cung cấp (provider) mà không phải thay đổi mã nguồn chính.

2.2. Các Mức Độ Logging

Mỗi thông điệp log đều có một mức độ nhất định, giúp bạn lọc thông tin một cách linh động:

Mức độ	Miêu tả
Trace	Chi tiết nhật ký cực kỳ chi tiết, dùng chủ yếu cho mục đích nghiên cứu.
Debug	Thông tin hữu ích trong quá trình debug nhưng có thể quá nhiều cho môi trường sản xuất.
Information	Thông tin tổng hợp về luồng xử lý và hoạt động của ứng dụng.
Warning	Cảnh báo về những sự kiện không mong đợi hoặc có thể dẫn đến lỗi.
Error	Các lỗi không mong đợi xảy ra trong quá trình chạy, cần được xử lý.
Critical	Các lỗi nghiêm trọng làm hỏng ứng dụng hoặc gây ra sự cố lớn.

---

3. Cấu Hình Logging trong ASP.NET Core

3.1. Cấu Hình Qua Program.cs (hoặc Startup.cs)

Trong ASP.NET Core (đặc biệt với phiên bản 3.1 trở đi và .NET 6+), bạn có thể cấu hình logging rất dễ dàng thông qua đối tượng WebApplicationBuilder:

var builder = WebApplication.CreateBuilder(args);

// Xoá các providers mặc định nếu cần
builder.Logging.ClearProviders();

// Thêm provider ghi log ra Console
builder.Logging.AddConsole();

// Thêm provider ghi log theo Debug (ví dụ: Visual Studio Debug Output)
builder.Logging.AddDebug();

var app = builder.Build();

app.MapGet("/", (ILogger<Program> logger) =>
{
    logger.LogInformation("Endpoint '/' được truy cập");
    return "Hello ASP.NET Core!";
});

app.Run();

Ở đây, bạn có thể thêm hoặc xoá các provider tùy thích. ASP.NET Core hỗ trợ sẵn các provider như:

• Console
• Debug
• EventLog (trên Windows)
• TraceSource

Ngoài ra, bạn hoàn toàn có thể tích hợp các thư viện logging ngoài như Serilog, NLog, hoặc Log4Net để có nhiều tính năng hơn như ghi log ra file, cơ sở dữ liệu hay dịch vụ từ xa.

3.2. Cấu Hình Qua appsettings.json

Bạn cũng có thể cấu hình mức độ log thông qua tệp appsettings.json:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

Cấu hình này cho phép bạn linh động điều chỉnh mức log cho từng bộ phận của framework:

• "Default" áp dụng cho toàn bộ ứng dụng.
• Các mục "Microsoft" hay "Microsoft.Hosting.Lifetime" giúp lọc log từ các thư viện hoặc thành phần của Microsoft.

4. Sử Dụng ILogger Trong Ứng Dụng

Nhờ vào cơ chế Dependency Injection (DI) của ASP.NET Core, việc sử dụng ILogger<T> trở nên cực kỳ đơn giản. Ví dụ, trong một controller:

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Trang Index được truy cập vào lúc {Time}", DateTime.Now);
        return View();
    }
}

Ở đây, ASP.NET Core sẽ tự động inject một instance của ILogger<HomeController> vào controller của bạn, từ đó bạn có thể sử dụng để ghi nhận các sự kiện theo cách an toàn và tối ưu.

           +-------------------+
           |   LoggerFactory   |
           +-------------------+
                     |
       +-------------+-------------+-------------+
       |                           |             |
+--------------+           +---------------+    +---------------+
| Console      |           | Debug         |    | Custom (Serilog|
| Provider     |           | Provider      |    | / NLog, ...)  |
+--------------+           +---------------+    +---------------+

using Serilog;

var builder = WebApplication.CreateBuilder(args);

// Cấu hình Serilog
Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .WriteTo.File("logs/myapp.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();

// Thay thế các providers mặc định bằng Serilog
builder.Host.UseSerilog();

var app = builder.Build();
app.MapGet("/", (ILogger<Program> logger) =>
{
    logger.LogInformation("Ghi log qua Serilog");
    return "Hello with Serilog!";
});
app.Run();