1. IronPDF
  2. IronPDF博客
  3. .NET 帮助
  4. csharp日志
.NET 帮助

C# 日志（它如何为开发人员工作）

发布 2024年四月3日
分享:

日志记录是软件开发不可或缺的一部分，它为开发人员提供了有关应用程序行为的宝贵见解，并有助于调试、监控和故障排除。在 C# 和 SQL Server 领域，有效的结构化日志 API 机制对于确保应用程序的稳健性和可靠性至关重要。本综合指南将探讨日志记录提供者的重要性、C# 中可用的各种日志记录框架、实施日志记录框架的最佳实践以及高级技术，以帮助您掌握在您的应用程序中记录日志的方法。 C# 日志 应用。我们还将讨论如何使用 IronPDF.

1.为什么要记录日志

在深入探讨技术细节之前，我们先来了解一下为什么日志记录在软件开发中不可或缺：

  1. 调试：日志记录有助于开发人员在整个开发生命周期中发现和诊断问题。详细的日志文件信息提供了有关执行流程、变量值和潜在错误的宝贵信息，有助于高效调试。

  2. 监控：在生产环境中，日志可作为一种监控工具，使运营团队能够跟踪应用程序行为、检测异常情况并主动排除故障。监控日志有助于识别性能瓶颈、安全漏洞和关键事件。

  3. 审计与合规性：日志记录通常是金融和医疗保健等各行各业的监管要求。具有最低日志级别的全面日志可确保问责制、促进审计并证明符合数据保护法规。

  4. 性能优化：通过分析日志，开发人员可以确定需要优化性能的方面，例如效率低下的数据库查询或缓慢的外部服务调用。优化这些方面可提高应用程序的性能和可扩展性。

2.C&num 中的日志框架；

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
VB   C#

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
VB   C#

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
VB   C#

C# 日志（如何为开发人员工作）：图 3 - Microsoft.Extensions.Logging 输出

3.登录 C&num 的最佳做法；

为确保在 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(创建日志报告的最佳 PDF 库)

IronPDF 是一个全面的 C# 库，它使开发人员能够在其 .NET 应用程序中无缝地创建、编辑和处理 PDF 文档。无论您是需要生成 PDF 报告、将 HTML 转换为 PDF 还是从 PDF 文件中提取文本，IronPDF 都能提供丰富的功能来满足您的要求。凭借其直观的 API 和强大的功能，IronPDF 简化了 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
VB   C#

第 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 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 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 file
		Dim outputPath = "LogReport.pdf"
		pdf.SaveAs(outputPath)
	End Sub
End Class
VB   C#

第 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
VB   C#

该代码使用 **LogService 获取示例日志数据，生成日志报告的 HTML 表示形式，使用 IronPDF 的 ChromePdfRenderer 渲染器将其转换为 PDF，将 PDF 保存为文件，然后打开查看。

C# 日志（如何为开发人员工作）：图 4 - 日志报告输出

6.结论

日志记录是现代软件开发的重要组成部分，可为开发人员提供有关应用程序行为和性能的宝贵见解。无论是在开发过程中调试代码，还是在生产环境中监控应用程序的运行状况，日志记录都为系统运行提供了重要的可见性。C# 中有大量日志框架可供选择，开发人员可以根据自己的需要灵活选择最合适的工具，无论是性能卓越的 NLog、结构化日志功能的 Serilog 还是轻量级抽象的 Microsoft.Extensions.Logging。

IronPDF 是在 C# 应用程序中无缝生成 PDF 日志报告的强大工具。其直观的应用程序接口（API）简化了将日志数据转换为具有视觉吸引力和可操作性的 PDF 文档的过程。通过将 IronPDF 集成到应用程序中，开发人员可以增强其日志功能，并为利益相关者提供有关应用程序行为的全面见解。从创建详细的审计日志到生成性能报告，IronPDF 使开发人员能够在其 C# 应用程序中充分发挥生成 PDF 文档的潜力，进一步丰富开发和维护体验。

欲了解有关 IronPDF 及其功能的更多信息，请访问官方网站 文档页面 只需 $749 即可将其转换为生产许可证。

< 前一页
C# Imap（针对开发者的工作原理）
下一步 >
C# While (它是如何为开发人员工作的)

报告问题

准备开始了吗？ 版本： 2024.10 刚刚发布

免费NuGet下载 总下载量: 11,108,738 查看许可证 >

获取您的免费

30天试用密钥 立即。

15天试用密钥 立即。

bullet_checked无需信用卡或创建账户
试用表格已提交
成功地。

您的试用密钥应在电子邮件中。
如果不是，请联系
support@ironsoftware.com

子弹测试测试生产环境
无水印
子弹日历30天全功能使用
功能性产品
子弹支持24/5技术支持
试用期间的支持

谢谢！

您的许可证密钥已发送到所提供的电子邮件。联系我们

24小时升级优惠：

Save 50% 在一个
专业 升级

去 专业 支持10位开发者
和无限项目。

小时

:

分钟

:

秒

升级到Professional

升级

专业

$600 美元

$299 美元

  • 10位开发者
  • 10个位置
  • 10个项目
今天 只有

5个.NET产品，两件的价格

IronPDF IronOCR IronXL IronBarcode IronWebscraper

套件总价值：

$7,192 美元

升级价格

今天
只有

$499 美元

24小时后

$1,098 美元