1. IronPDF
  2. IronPDF 部落格
  3. .NET 幫助
  4. csharp-log
.NET 幫助

C# 日誌（開發人員的運作方式）

Chipego
奇佩戈·卡林达
2024年4月3日
分享:

記錄是軟體開發不可或缺的一部分，為開發人員提供應用程式行為的重要見解，有助於除錯、監控和故障排除。 在 C# 和 SQL Server 領域中，確保應用程式強健性和可靠性的有效結構化日誌 API 機制至關重要。 本綜合指南將探討記錄提供程式的重要性、C# 中可用的各種日誌框架、日誌框架實施的最佳做法，以及幫助您掌握在C# 日誌應用程式中記錄的進階技術。 我們還將討論如何使用IronPDF for PDF Generation創建 PDF 日誌消息報告。

1. 為什麼記錄很重要

在深入探討技術細節之前，讓我們了解為什麼記錄對於軟體開發是不可或缺的：

  1. 除錯：記錄有助於開發人員在開發生命週期中識別和診斷問題。 詳細的日誌檔案信息提供了關於執行流程、變數值和潛在錯誤的寶貴信息，有助於提高調試效率。

  2. 監控：在生產環境中，日誌充當監控工具，允許操作團隊追踪應用程序行為、檢測異常並主動排除問題。 監控日誌有助於識別性能瓶頸、安全漏洞和關鍵事件。

  3. 審計和合規：記錄通常是各個行業的監管要求，例如金融和醫療保健。 完整的日誌記錄加上最低限度的日誌級別確保責任、促進稽核，並彰顯符合數據保護法規。

  4. 性能優化：日誌分析可以幫助開發人員識別性能優化區域，例如效率低下的資料庫查詢或緩慢的外部服務呼叫。 優化這些方面可提升應用程式的性能和可擴展性。

2. C#中的日誌框架

C# 提供了數個日誌框架，每個都有其特點和功能。 讓我們探討一些流行的日誌記錄提供者及其代碼範例：

2.1. NLog

NLog 是一個高性能的日誌記錄庫，具有廣泛的配置文件選項。 以下是一個在 C# 應用程式中使用 NLog 撰寫日誌訊息的簡單示例：

// Install-Package NLog
using NLog;
public class Program
{
    private static readonly Logger logger = LogManager.GetCurrentClassLogger();
    static void Main(string [] args)
    {
        logger.Info("Info message");
        logger.Warn("Warning message");
        logger.Error("Error message");
        logger.Fatal("Fatal error message");
    }
}
// Install-Package NLog
using NLog;
public class Program
{
    private static readonly Logger logger = LogManager.GetCurrentClassLogger();
    static void Main(string [] args)
    {
        logger.Info("Info message");
        logger.Warn("Warning message");
        logger.Error("Error message");
        logger.Fatal("Fatal error message");
    }
}
' Install-Package NLog
Imports NLog
Public Class Program
	Private Shared ReadOnly logger As Logger = LogManager.GetCurrentClassLogger()
	Shared Sub Main(ByVal args() As String)
		logger.Info("Info message")
		logger.Warn("Warning message")
		logger.Error("Error message")
		logger.Fatal("Fatal error message")
	End Sub
End Class
$vbLabelText   $csharpLabel

C# 日誌（對開發者的工作原理）：圖 1 - 日誌訊息輸出

2.2. Serilog

Serilog 專注於結構化日誌記錄 API 並與現代日誌後端無縫集成。 以下是如何在 C# 應用程式中使用 Serilog：

// Install-Package Serilog
// Install-Package Serilog.Sinks.Console
using Serilog;
public class Program
{
    static void Main(string [] args)
    {
        // configuration file
        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .CreateLogger();
        // log debug message
        Log.Debug("Debug message");
        Log.Information("Info message");
        Log.Warning("Warning message");
        Log.Error("Error message");
        Log.Fatal("Fatal error message");
    }
}
// Install-Package Serilog
// Install-Package Serilog.Sinks.Console
using Serilog;
public class Program
{
    static void Main(string [] args)
    {
        // configuration file
        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .CreateLogger();
        // log debug message
        Log.Debug("Debug message");
        Log.Information("Info message");
        Log.Warning("Warning message");
        Log.Error("Error message");
        Log.Fatal("Fatal error message");
    }
}
' Install-Package Serilog
' Install-Package Serilog.Sinks.Console
Imports Serilog
Public Class Program
	Shared Sub Main(ByVal args() As String)
		' configuration file
		Log.Logger = (New LoggerConfiguration()).WriteTo.Console().CreateLogger()
		' log debug message
		Log.Debug("Debug message")
		Log.Information("Info message")
		Log.Warning("Warning message")
		Log.Error("Error message")
		Log.Fatal("Fatal error message")
	End Sub
End Class
$vbLabelText   $csharpLabel

C# 日誌（對開發者的工作原理）：圖2 - 配置文件日誌輸出

2.3. Microsoft.Extensions.Logging

Microsoft.Extensions.Logging 是一個包含在 .NET Core 生態系統中的輕量級日誌記錄抽象。 以下是其使用的基本示例：

// Install-Package Microsoft.Extensions.Logging
using Microsoft.Extensions.Logging;
public class Program
{
    static void Main(string [] args)
    {
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Add console logger
        });
        ILogger logger = loggerFactory.CreateLogger<Program>();
        logger.LogDebug("Debug message");
        logger.LogInformation("Info message");
        logger.LogWarning("Warning message");
        logger.LogError("Error message");
        logger.LogCritical("Critical error message");
    }
}
// Install-Package Microsoft.Extensions.Logging
using Microsoft.Extensions.Logging;
public class Program
{
    static void Main(string [] args)
    {
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Add console logger
        });
        ILogger logger = loggerFactory.CreateLogger<Program>();
        logger.LogDebug("Debug message");
        logger.LogInformation("Info message");
        logger.LogWarning("Warning message");
        logger.LogError("Error message");
        logger.LogCritical("Critical error message");
    }
}
' Install-Package Microsoft.Extensions.Logging
Imports Microsoft.Extensions.Logging
Public Class Program
	Shared Sub Main(ByVal args() As String)
		Dim loggerFactory As ILoggerFactory = LoggerFactory.Create(Sub(builder)
			builder.AddConsole() ' Add console logger
		End Sub)
		Dim logger As ILogger = loggerFactory.CreateLogger(Of Program)()
		logger.LogDebug("Debug message")
		logger.LogInformation("Info message")
		logger.LogWarning("Warning message")
		logger.LogError("Error message")
		logger.LogCritical("Critical error message")
	End Sub
End Class
$vbLabelText   $csharpLabel

C# 日誌（它如何對開發人員起作用）：圖 3 - Microsoft.Extensions.Logging 輸出

3. C# 日誌記錄的最佳實踐

為了確保在您的 C# 應用程序中進行有效的日誌記錄，請考慮以下最佳實踐：

  1. 使用描述性日誌訊息：撰寫日誌訊息時應提供有意義的上下文，說明所記錄事件的相關資訊。 包括相關資訊，例如時間戳記、錯誤代碼、用戶 ID 和操作詳情，以協助進行故障排除。

  2. 選擇適當的日誌等級：根據記錄事件的嚴重性使用不同的日誌等級（例如，DEBUG、INFO、WARN、ERROR、FATAL）。 將較低的日誌等級（例如 DEBUG）保留用於詳細的調試資訊，將較高等級（例如 ERROR、FATAL）用於需要立即注意的關鍵錯誤。

  3. 實施日誌輪換：通過實施日誌輪換機制來防止日誌文件無限增長。 配置最大檔案大小或基於時間的輪換，以歸檔較舊的日誌並保持可管理的日誌大小。

  4. 保護敏感資訊：避免記錄敏感資訊，如密碼、API 金鑰和個人識別資訊（PII）。 實施適當的編輯或模糊技術以保護日誌中的敏感數據。

  5. 集中化日誌管理：考慮使用像 Elasticsearch、Splunk 或 Azure Application Insights 這樣的集中式日誌解決方案，來彙總和分析來自多個來源的日誌。 集中式日誌記錄便於日誌搜索、分析和可視化，增強故障排除能力。

  6. 啟用結構化日誌：採用 JSON 或鍵值對等結構化日誌格式以機器可讀的格式呈現日誌事件。 結構化日誌相比純文本日誌更便於解析、過濾和分析。

  7. 監控日誌健康狀況：監控日誌基礎設施的健康狀況和可用性，以確保日誌收集和分析不中斷。 實施警報以應對關鍵日誌問題，如磁碟空間耗盡、網路連接問題或服務停機。

4 種高級日誌記錄技術

除了基本功能外，還有多種進階日誌技術可以進一步提升您在 C# 中的日誌功能：

  1. 情境記錄：透過包含 HTTP 請求標頭、會話 ID 或關聯 ID 等情境資訊來豐富日誌事件，以便追蹤分散式系統中的執行流程。

  2. 非同步日誌記錄：透過將日誌記錄操作卸載到背景線程或非同步任務，來提高應用程式的性能。 非同步日誌記錄可防止阻塞主執行緒，並將對應用程式響應速度的影響降至最低。

  3. 異常記錄和處理：實施結構化異常記錄，以捕獲關於異常的詳細資訊，包括堆疊追蹤、內部異常和異常上下文。 妥善處理例外並在適當的日誌級別記錄，以協助故障排除和錯誤恢復。

  4. 效能記錄：使用效能記錄來測試關鍵程式碼路徑，以量測和分析應用程式效能指標，例如響應時間、吞吐量和資源使用情況。 效能日誌有助於識別性能瓶頸並優化應用程式效率。

  5. 日誌關聯和聚合：通過在日誌消息中包含唯一標識符或跟蹤 ID，將分散元件或微服務中的相關日誌事件關聯起來。 彙總相關日誌以獲得分佈式系統行為和故障排除的全貌。

5. IronPDF：最佳 C# 程式庫，用於建立日誌報告

IronPDF 是一個全面的 C# 程式庫，使開發人員能夠在其 .NET 應用程式中無縫地創建、編輯和操作 PDF 文件。 無論您需要生成 PDF 報告、將 HTML 轉換為 PDF，或從 PDF 文件中提取文本，IronPDF 都提供豐富的功能集來滿足您的需求。 IronPDF 具有直觀的 API 和強大的功能，簡化了 PDF 生成和操作任務，使開發者能夠為其應用程式增強高品質的 PDF 文件功能。

5.1. 使用 IronPDF 建立日誌報告

從日誌資料生成 PDF 報告是在許多應用程式中常見的需求，為利害關係人提供有關應用程式行為和性能的寶貴見解。 在此範例中，我們將演示如何使用 IronPDF 建立包含日志條目和相關元數據的日志報告。

步驟 1：安裝 IronPDF 套件

首先，確保您已在專案中安裝了IronPDF套件。 您可以透過 NuGet 套件管理器或 NuGet 套件主控台來安裝它：

Install-Package IronPdf

步驟 2：建立日誌數據

出於示範目的，讓我們在應用程式中創建一些範例日誌數據。 您可以使用您偏好的日誌框架或簡單地手動記錄條目：

using System;
using System.Collections.Generic;
public class LogEntry
{
    public DateTime Timestamp { get; set; }
    public string Message { get; set; }
    public LogLevel Level { get; set; }
}
public enum LogLevel
{
    Info,
    Warning,
    Error
}
public class LogService
{
    public List<LogEntry> GetLogEntries()
    {
        // Sample log entries
        var logEntries = new List<LogEntry>
        {
            new LogEntry { Timestamp = DateTime.Now, Message = "Application started.", Level = LogLevel.Info },
            new LogEntry { Timestamp = DateTime.Now, Message = "Warning: Disk space low.", Level = LogLevel.Warning },
            new LogEntry { Timestamp = DateTime.Now, Message = "Error: Database connection failed.", Level = LogLevel.Error }
        };
        return logEntries;
    }
}
using System;
using System.Collections.Generic;
public class LogEntry
{
    public DateTime Timestamp { get; set; }
    public string Message { get; set; }
    public LogLevel Level { get; set; }
}
public enum LogLevel
{
    Info,
    Warning,
    Error
}
public class LogService
{
    public List<LogEntry> GetLogEntries()
    {
        // Sample log entries
        var logEntries = new List<LogEntry>
        {
            new LogEntry { Timestamp = DateTime.Now, Message = "Application started.", Level = LogLevel.Info },
            new LogEntry { Timestamp = DateTime.Now, Message = "Warning: Disk space low.", Level = LogLevel.Warning },
            new LogEntry { Timestamp = DateTime.Now, Message = "Error: Database connection failed.", Level = LogLevel.Error }
        };
        return logEntries;
    }
}
Imports System
Imports System.Collections.Generic
Public Class LogEntry
	Public Property Timestamp() As DateTime
	Public Property Message() As String
	Public Property Level() As LogLevel
End Class
Public Enum LogLevel
	Info
	Warning
	[Error]
End Enum
Public Class LogService
	Public Function GetLogEntries() As List(Of LogEntry)
		' Sample log entries
		Dim logEntries = New List(Of LogEntry) From {
			New LogEntry With {
				.Timestamp = DateTime.Now,
				.Message = "Application started.",
				.Level = LogLevel.Info
			},
			New LogEntry With {
				.Timestamp = DateTime.Now,
				.Message = "Warning: Disk space low.",
				.Level = LogLevel.Warning
			},
			New LogEntry With {
				.Timestamp = DateTime.Now,
				.Message = "Error: Database connection failed.",
				.Level = LogLevel.Error
			}
		}
		Return logEntries
	End Function
End Class
$vbLabelText   $csharpLabel

第 3 步：生成 PDF 報告

現在，讓我們使用 IronPDF 從日誌數據生成 PDF 報告。

using IronPdf;
using System.IO;
public class PdfReportGenerator
{
    public void GenerateLogReport(List<LogEntry> logEntries)
    {
        var renderer = new ChromePdfRenderer();
        var htmlContent = "<h1>Log Report</h1><hr/><ul>";
        foreach (var entry in logEntries)
        {
            htmlContent += $"<li><strong>{entry.Timestamp}</strong> - [{entry.Level}] {entry.Message}</li>";
        }
        htmlContent += "</ul>";
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        // Save PDF to a file
        var outputPath = "LogReport.pdf";
        pdf.SaveAs(outputPath);
    }
}
using IronPdf;
using System.IO;
public class PdfReportGenerator
{
    public void GenerateLogReport(List<LogEntry> logEntries)
    {
        var renderer = new ChromePdfRenderer();
        var htmlContent = "<h1>Log Report</h1><hr/><ul>";
        foreach (var entry in logEntries)
        {
            htmlContent += $"<li><strong>{entry.Timestamp}</strong> - [{entry.Level}] {entry.Message}</li>";
        }
        htmlContent += "</ul>";
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        // Save PDF to a file
        var outputPath = "LogReport.pdf";
        pdf.SaveAs(outputPath);
    }
}
Imports IronPdf
Imports System.IO
Public Class PdfReportGenerator
	Public Sub GenerateLogReport(ByVal logEntries As List(Of LogEntry))
		Dim renderer = New ChromePdfRenderer()
		Dim htmlContent = "<h1>Log Report</h1><hr/><ul>"
		For Each entry In logEntries
			htmlContent &= $"<li><strong>{entry.Timestamp}</strong> - [{entry.Level}] {entry.Message}</li>"
		Next entry
		htmlContent &= "</ul>"
		Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
		' Save PDF to a file
		Dim outputPath = "LogReport.pdf"
		pdf.SaveAs(outputPath)
	End Sub
End Class
$vbLabelText   $csharpLabel

步驟 4：生成並查看日誌報告

最後，我們來創建一個LogService實例，以提取日誌數據並生成 PDF 報告。

class Program
{
    static void Main(string [] args)
    {
        var logService = new LogService();
        var logEntries = logService.GetLogEntries();
        var pdfGenerator = new PdfReportGenerator();
        pdfGenerator.GenerateLogReport(logEntries);
    }
}
class Program
{
    static void Main(string [] args)
    {
        var logService = new LogService();
        var logEntries = logService.GetLogEntries();
        var pdfGenerator = new PdfReportGenerator();
        pdfGenerator.GenerateLogReport(logEntries);
    }
}
Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim logService As New LogService()
		Dim logEntries = logService.GetLogEntries()
		Dim pdfGenerator = New PdfReportGenerator()
		pdfGenerator.GenerateLogReport(logEntries)
	End Sub
End Class
$vbLabelText   $csharpLabel

此代碼使用LogService獲取樣本日誌數據，生成日誌報告的 HTML 表示，使用 IronPDF 的 ChromePdfRenderer 將其轉換為 PDF，將 PDF 保存到文件中，並打開以供查看。

C# 日誌（開發人員如何使用）：圖 4 - 日誌報告輸出

6. 結論

日誌記錄是現代軟體開發的重要組成部分，為開發者提供對應用程式行為和性能的寶貴洞察。 無論是在開發期間調試代碼還是在生產環境中監控應用程式健康狀況，日誌都為系統運行提供了基本的可視性。 在 C# 中有著大量的日誌框架可供選擇，開發人員能夠靈活地選擇最適合其需求的工具，無論是因其效能而選擇 NLog，為結構化日誌功能選擇 Serilog，還是為輕量級抽象選擇 Microsoft.Extensions.Logging。

IronPDF C# PDF Library 是在 C# 應用程式中無縫生成 PDF 日誌報告的強大工具。 其直觀的 API 簡化了將日誌數據轉換為視覺吸引且可操作的 PDF 文件的過程。 通過將IronPDF整合到他們的應用程式中，開發人員可以增強其日誌記錄功能，並為相關方提供有關應用程式行為的全面見解。 從創建詳細的審計日誌到生成性能報告，IronPDF 使開發人員能夠在其 C# 應用程式中充分利用 PDF 文件生成的潛力，進一步豐富了開發和維護體驗。

欲了解更多關於IronPDF及其功能的信息，請訪問官方IronPDF 授權文件並探索如何將其轉換為生產模式。

Chipego
奇佩戈·卡林达
  立即與工程團隊聊天
軟體工程師
Chipego 擁有天生的傾聽技能，這幫助他理解客戶問題，並提供智能解決方案。他在獲得信息技術理學學士學位後，于 2023 年加入 Iron Software 團隊。IronPDF 和 IronOCR 是 Chipego 專注的兩個產品，但隨著他每天找到新的方法來支持客戶，他對所有產品的了解也在不斷增長。他喜歡在 Iron Software 的協作生活，公司內的團隊成員從各自不同的經歷中共同努力，創造出有效的創新解決方案。當 Chipego 離開辦公桌時，他常常享受讀好書或踢足球的樂趣。
< 上一頁
C# Imap（開發人員如何運作）
下一個 >
C＃ While（它是如何為開發人員運作的）
從NuGet 免費用於開發

安裝與 NuGet nuget.org/packages/IronPdf

PM > Install-Package IronPdf

報告問題

準備開始了嗎？ 版本： 2025.4 剛剛發布

免費開始
NuGet 下載 DLL 下載 Windows 安裝程式 開始免費試用
查看許可證 >
Textlogo Iron Suite related to C# 日誌（開發人員的運作方式）

IronPDF 是 IRON 的一部分套件

10 .NET API 產品適用於您的辦公文檔

以兩件產品的價格獲得十件產品   開始免費試用