.NET下优秀的日志框架Serilog，你用上了吗？(".NET开发者必备：高效日志框架Serilog，你掌握了吗？")

原创

ithorizon 6个月前 (10-20) 阅读数 22 #后端开发

.NET开发者必备：高效日志框架Serilog，你掌握了吗？

.NET下优秀的日志框架Serilog，你用上了吗？

在软件开发过程中，日志记录是不可或缺的一部分。一个好的日志系统可以帮助我们飞速定位问题、分析系统运行状态，以及优化代码性能。在.NET领域，Serilog作为一种高效的日志框架，以其灵活性和强势的功能赢得了众多开发者的青睐。本文将详细介绍Serilog的使用方法，帮助.NET开发者掌握这一必备技能。

一、Serilog简介

Serilog是一个强势的日志框架，它赞成结构化日志记录，并提供了充裕的日志输出格式和 sinks（输出目标）。Serilog的设计理念是“明了、灵活、可扩展”，这让它成为.NET开发者的首选日志框架。

二、Serilog的核心概念

Serilog的核心概念包括：

Logger：日志记录器，用于创建和配置日志记录器实例。

Enrichment：充裕器，用于在日志记录过程中添加额外的信息。

Writer：写入器，用于将日志记录输出到不同的目标。

Sinks：输出目标，用于定义日志记录的输出位置，如控制台、文件、数据库等。

三、安装Serilog

在.NET项目中使用Serilog，首先需要安装相关的NuGet包。以下是安装Serilog的基本步骤：


        dotnet add package Serilog
        dotnet add package Serilog.Sinks.Console
        dotnet add package Serilog.Sinks.File

这里我们安装了Serilog的核心库以及控制台和文件输出目标。

四、配置Serilog

在项目中配置Serilog，通常需要创建一个配置文件（如 appsettings.json），并在程序启动时进行配置。以下是一个基本的配置示例：


        {
            "Serilog": {
                "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.File"],
                "MinimumLevel": "Information",
                "Enrich": ["Serilog.Enrich.WithMachineName"],
                "WriteTo": [
                    {
                        "Name": "console",
                        "Args": {
                            "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"
                        }
                    },
                    {
                        "Name": "file",
                        "Args": {
                            "path": "logs/myapp.log",
                            "outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"
                        }
                    }
                ]
            }
        }

在这个配置文件中，我们设置了日志的最低记录级别为 Information，并添加了控制台和文件输出目标。同时，我们还通过 Enrich 添加了机器名作为日志的额外信息。

五、使用Serilog记录日志

配置好Serilog后，我们可以在代码中使用 Logger 来记录日志。以下是一个明了的示例：


        using Serilog;
        class Program
        {
            static void Main(string[] args)
            {
                Log.Logger = new LoggerConfiguration()
                    .ReadFrom.Configuration(ConfigurationBuilder.Configuration)
                    .CreateLogger();
                Log.Information("This is an informational message.");
                Log.Warning("This is a warning message.");
                Log.Error("This is an error message.");
                try
                {
                    throw new InvalidOperationException("Example exception");
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "Caught an exception");
                }
                Log.CloseAndFlush();
            }
        }