
Apabila aplikasi ASP.NET Core mula mengeluarkan ralat di pelayan produksi, fail log ialah tempat pertama yang anda buka. Malangnya, dua ekstrem yang sama-sama menyusahkan sering berlaku dalam kod projek sebenar:
- Log yang terlalu kedekut:
catch (Exception ex) { _logger.LogError("Error happened"); }— langsung tidak memberitahu pesanan mana yang gagal, gateway mana yang timeout, atau punca sebenar pengecualian itu. - Log yang terlalu rakus: Mencetak keseluruhan body JSON permintaan pengguna ke dalam log—secara tidak sengaja menyimpan kata laluan, nombor kad pengenalan, token JWT, atau butiran kad pelanggan dalam fail teks biasa atau papan pemuka log pihak ketiga.
Log yang matang berada di tengah: kaya dengan konteks teknikal untuk menjejak aliran permintaan, tetapi ketat menyaring maklumat peribadi dan rahsia.
Gunakan Structured Logging, bukan String Interpolation
Dalam dokumentasi rasmi logging ASP.NET Core, amalan teras ialah menggunakan templat mesej berstruktur supaya alat carian log (seperti Serilog, Seq, Application Insights, atau journalctl bersama JSON formatter) boleh menapis mengikut medan tertentu:
// ELAKKAN: String interpolation menyukarkan carian log berstruktur
_logger.LogWarning($"Gateway timeout for order {orderId} after {elapsedMs}ms");
// BETUL: Gunakan message template supaya OrderId dan ElapsedMs diindeks sebagai medan
_logger.LogWarning(
"Payment gateway timeout for {OrderId} after {ElapsedMs}ms (TraceId: {TraceId})",
orderId,
elapsedMs,
HttpContext.TraceIdentifier);
Perhatikan HttpContext.TraceIdentifier (atau Activity.Current?.Id jika anda menggunakan OpenTelemetry): apabila seorang pengguna mengadu “Saya dapat ralat masa klik bayar FPX pukul 2:15 petang”, memulangkan ID rujukan (traceId) tersebut di skrin ralat membolehkan anda mencari keseluruhan jejak permintaan itu dalam masa lima saat—tanpa perlu meneka baris mana yang milik pengguna tersebut.
Jika satu permintaan melalui beberapa servis atau kelas pembantu, gunakan BeginScope supaya OrderId atau TenantId melekat pada semua log dalam skop tersebut secara automatik:
using (_logger.BeginScope(new Dictionary<string, object>
{
["OrderId"] = orderId,
["TraceId"] = HttpContext.TraceIdentifier
}))
{
_logger.LogInformation("Starting payment verification");
// Sebarang LogWarning/LogError di dalam blok ini akan membawa OrderId dan TraceId
}
Kawal tahap log supaya amaran penting tidak tenggelam
Salah satu punca log produksi cepat penuh (atau bil storan log melambung) ialah apabila semua ralat dilabel LogError. Jika ralat validasi biasa daripada pengguna—contohnya tersalah taip format e-mel atau status 404—dilog sebagai Error, amaran sebenar seperti pangkalan data putus sambungan atau payment callback gagal akan tenggelam dalam ribuan baris bunyi bising.
Susun tahap log dengan disiplin mudah ini:
Information: Peristiwa perniagaan penting yang sah, seperti pesanan berjaya disahkan atau tugas berjadual selesai.Warning: Keadaan luar jangka yang masih boleh dipulihkan, seperti API luar lambat menjawab atau cubaan semula (retry) berlaku.Error/Critical: Kegagalan sebenar yang memerlukan perhatian pembangun atau menjejaskan transaksi.
Dalam appsettings.Production.json, turunkan bunyi bising daripada rangka kerja sendiri supaya log anda kekal bersih:
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning",
"Microsoft.EntityFrameworkCore.Database.Command": "Warning"
}
}
}
Lindungi data sensitif sebelum masuk ke fail log
Jika anda mengaktifkan HTTP Logging Middleware atau menggunakan penapis pengecualian global, pastikan Authorization header, Cookie, kata laluan, kunci API, dan payload borang sensitif (seperti laluan /login, /register, atau /checkout) tidak pernah dicetak mentah. Sekali data peribadi masuk ke dalam fail log yang diarkibkan, kerja membersihkannya semula jauh lebih rumit berbanding menapisnya dari awal.
Sebelum go-live, jalankan satu simulasi kegagalan di persekitaran staging: matikan sambungan ke API luar atau paksa timeout, kemudian minta rakan sepasukan yang tidak menulis kod itu mencari punca menggunakan log sahaja. Jika mereka boleh menjejak langkah mana yang gagal melalui TraceId tanpa melihat data peribadi pelanggan, bermakna struktur log anda sudah bersedia untuk produksi.