简单了解SeriLog

鲁鸿

2023-12-01

简单了解SeriLog
serilog 一般分为如下几个等级(从低到高排列，等级最高是Fatal)。

log.Verbose(“verbose”); // 好像没什么用，也不会输出显示出来

//以下为常用记录日志方法
log.Information(“info”);
log.Debug(“debug”);
log.Warning(“warning”);
log.Error(“err”);
log.Fatal(“fatal”);
无论是core或framework ，配置基本相同，就是声明一个（如下代码）

Log.Logger = new LoggerConfiguration() .CreateLogger();
当然上面的代码配置根本是不够的，你想个性化设置日志输出到什么地方，需要引用一些serilog的接收器。Serilog的输出对象称之为Sink（水槽，也就是接收器）,nuget中搜索关键词serilog.sinks, 会发现有一堆组件。

常见的接收器

github上提供了大量的第三方的可用sinks，这里简单的列举几个常用的：

Console 输出到控制台
Debug 输出到VS的Debug窗口
Trace 输出到VS的控制台
File 输出到文件
Rolling File
MongoDB 输出到MongoDB
LiteDB 输出到文件数据库LiteDB
SQLite 输出到文件数据库SQLite
SignalR 输出为SignalR服务
HTTP 输出到REST服务
1 简单的配置SeriLog
这里简单的配置下：输出日志到控制台，或生成txt日志文件在项目根目录下（core或framework基配代码置本一样）。

首先nuget引用下相关的组件（共4个）。

serilog和接收器
在winform下配置，代码如下:

using System;
using System.Windows.Forms;
using Serilog;
using Serilog.Core;
using Serilog.Events;

namespace WindowsLog
{
static class Program
{
///
/// 应用程序的主入口点。
///
[STAThread]
static void Main()
{
//日志的输出模板
string LogFilePath(string LogEvent) => $@“Logs{LogEvent}\log.log”;
string SerilogOutputTemplate = “{NewLine}{NewLine}Date:{Timestamp:yyyy-MM-dd HH:mm:ss.fff} LogLevel：{Level}{NewLine}{Message}{NewLine}” + new string(’-’, 50)+ “{NewLine}”;
Log.Logger = new LoggerConfiguration()
// 将配置传给 Serilog 的提供程序
//.ReadFrom.Configuration(Configuration)
.Enrich.FromLogContext()//记录相关上下文信息
.MinimumLevel.Error()//最小记录级别
.MinimumLevel.Override(“Microsoft”, LogEventLevel.Information)//对其他日志进行重写,除此之外,目前框架只有微软自带的日志组件
.WriteTo.Console(outputTemplate: SerilogOutputTemplate)//输出到控制台
//.WriteTo.File() //输出到本地文件
.WriteTo.Logger(lg => lg.Filter.ByIncludingOnly(p => p.Level == LogEventLevel.Debug).WriteTo.File(LogFilePath(“Debug”), rollingInterval: RollingInterval.Day, outputTemplate: SerilogOutputTemplate))
.WriteTo.Logger(lg => lg.Filter.ByIncludingOnly(p => p.Level == LogEventLevel.Information).WriteTo.File(LogFilePath(“Information”), rollingInterval: RollingInterval.Day, outputTemplate: SerilogOutputTemplate))
.WriteTo.Logger(lg => lg.Filter.ByIncludingOnly(p => p.Level == LogEventLevel.Warning).WriteTo.File(LogFilePath(“Warning”), rollingInterval: RollingInterval.Day, outputTemplate: SerilogOutputTemplate))
.WriteTo.Logger(lg => lg.Filter.ByIncludingOnly(p => p.Level == LogEventLevel.Error).WriteTo.File(LogFilePath(“Error”), rollingInterval: RollingInterval.Day, outputTemplate: SerilogOutputTemplate))
.WriteTo.Logger(lg => lg.Filter.ByIncludingOnly(p => p.Level == LogEventLevel.Fatal).WriteTo.File(LogFilePath(“Fatal”), rollingInterval: RollingInterval.Day, outputTemplate: SerilogOutputTemplate))
.CreateLogger();

        //测试
        Log.Verbose("Application Started Verbose");
        Log.Debug("Application Started Debug");
        Log.Information("Application Started Information");
        Log.Error("Application Started Error");
        Log.Warning("Application Started Warning");
        Log.Fatal("Application Started Fatal");

        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);
        Application.Run(new Form1());
    }

    #region Serilog 相关设置
    class DateTimeNowEnricher : ILogEventEnricher
    {
        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
        {
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty(
                "DateTimeNow", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")));
        }
    }
    #endregion
}

}
2 在core下面配置，请参考
https://gitee.com/sundayisblue/BoYuanCore/blob/master/BoYuanCore.Web/Program.cs

3 在mvc5 中配置
//Information、Debug、Warning、Error、Fatal
//信息，调试，警告，错误，致命

public class Logger
{
    #region Serilog 相关设置

    /// <summary>
    /// 初始化默认方式的serilog
    /// </summary>
    /// <param name="logPath">输出txt日志路径</param>
    public static void InitLoggerDefault(string logPath)
    {
        //掉用方式: Application_Start 中 Logger.InitLoggerDefault(System.Web.Hosting.HostingEnvironment.MapPath("~/logs/" + DateTime.Now.Year + "/" + DateTime.Now.Month + "/log_.log"));

        Serilog.Log.Logger = new LoggerConfiguration()
            // 将配置传给 Serilog 的提供程序 
            //.ReadFrom.Configuration(Configuration)
            .Enrich.With(new DateTimeNowEnricher())
            .Enrich.FromLogContext()//记录相关上下文信息 
            .MinimumLevel.Debug()//最小记录级别
            .MinimumLevel.Override("Microsoft", LogEventLevel.Information)//对其他日志进行重写,除此之外,目前框架只有微软自带的日志组件
            //.WriteTo.Console()//输出到控制台 WriteTo.Async重写了
            //.WriteTo.File() //输出到本地文件 WriteTo.Async重写了
            .WriteTo.Async(o =>
            {
                o.Console();//输出到控制台。mvc中可能配置此方式不太好用，暂无修正
                o.File(logPath, //System.Web.Hosting.HostingEnvironment.MapPath("~/logs/" + DateTime.Now.Year + "/" + DateTime.Now.Month + "/log_.log" //在程序跟目录下/logs/2020/11/30/log_20201130.log
                    restrictedToMinimumLevel: LogEventLevel.Error, //最小写入级别
                    rollingInterval: RollingInterval.Day/*按天生成日志文件*/);
            })
            .CreateLogger();
    }

    public class DateTimeNowEnricher : ILogEventEnricher
    {
        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
        {
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty(
                "DateTimeNow", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")));
        }
    }
    #endregion


    /// <summary>
    /// 默认方式使用log
    /// </summary>
    public class Default
    {
        public static void Info(string msg, params object[] args)
        {
            Serilog.Log.Information(msg, args);
        }

        public static void Info(string msg, Exception err)
        {
            Serilog.Log.Information(msg, err);
        }


        public static void Debug(string msg, params object[] args)
        {
            Serilog.Log.Debug(msg, args);
        }

        public static void Debug(string msg, Exception err)
        {
            Serilog.Log.Debug(msg, err);
        }

        public static void Warning(string msg, params object[] args)
        {
            Serilog.Log.Warning(msg, args);
        }

        public static void Warning(string msg, Exception err)
        {
            Serilog.Log.Warning(msg, err);
        }

        public static void Error(string msg, params object[] args)
        {
            Serilog.Log.Error(msg, args);
        }

        public static void Error(string msg, Exception err)
        {
            Serilog.Log.Error(msg, err);
        }

        public static void Fatal(string msg, params object[] args)
        {
            Serilog.Log.Fatal(msg, args);
        }

        public static void Fatal(string msg, Exception err)
        {
            Serilog.Log.Fatal(msg, err);
        }
    }

}

参考：
https://www.cnblogs.com/TianFang/p/9416238.html
https://github.com/serilog-web/classic-mvc
https://www.cnblogs.com/mingmingruyuedlut/p/5133349.html

.NET NLog与Log4net与Serilog比较
https://stackify.com/nlog-vs-log4net-vs-serilog/
https://www.cnblogs.com/qtiger/p/13216271.html

作者：Sunday_1024
链接：https://www.jianshu.com/p/95a04afd8711
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

简单了解SeriLog

相关阅读

相关文章

相关问答

相关文档