You need to enable JavaScript to run this app.
最新活动
大模型
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们

如何实现Serilog无需重启服务动态切换日志文件路径?

解决Serilog动态修改日志路径后同时写入新旧路径的问题

这个问题我之前帮不少开发者处理过——本质原因是Serilog的File sink在初始化时就绑定了固定的文件路径,当你更新Consul里的配置后,只是相当于新增了一个指向新路径的sink,而旧的sink并没有被移除,所以日志会同时往两个路径输出。下面给你两种可靠的解决方案,都能实现无需重启服务,切换路径后只写新路径的需求:

方案一:手动替换Logger实例(最直接)

这种方式的核心是当配置变更时,关闭旧的Logger并创建一个指向新路径的新Logger,替换掉静态的Log.Logger实例。

步骤拆解

  1. 初始化时保留配置引用
    不要直接把构建好的Logger赋值给Log.Logger就完事,保留LoggerConfiguration的引用,方便后续重新构建:

    private static LoggerConfiguration _loggerConfig;
    private static ILogger _currentLogger;
    
    public static void InitLogger(string initialLogPath, long fileSizeLimitBytes, string applicationName)
    {
        _loggerConfig = new LoggerConfiguration()
            .WriteTo.File(
                Path.Combine(initialLogPath, $"{applicationName}_.txt"),
                LogEventLevel.Error,
                shared: true,
                fileSizeLimitBytes: fileSizeLimitBytes,
                rollOnFileSizeLimit: true,
                rollingInterval: RollingInterval.Day,
                outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] [{MachineName}] [{SourceContext}] {RequestId} {CorrelationId} {Message}{NewLine}{Exception}{properties}"
            );
        _currentLogger = _loggerConfig.CreateLogger();
        Log.Logger = _currentLogger;
    }
    
  2. 配置变更时更新Logger
    当监听到Consul里的日志路径变更时,执行以下操作:

    public static void UpdateLogPath(string newLogPath, long fileSizeLimitBytes, string applicationName)
    {
        // 先关闭旧Logger,确保所有未写入的日志都落地,释放文件句柄
        Log.CloseAndFlush();
    
        // 重新构建配置,指向新路径
        _loggerConfig = new LoggerConfiguration()
            .WriteTo.File(
                Path.Combine(newLogPath, $"{applicationName}_.txt"),
                LogEventLevel.Error,
                shared: true,
                fileSizeLimitBytes: fileSizeLimitBytes,
                rollOnFileSizeLimit: true,
                rollingInterval: RollingInterval.Day,
                outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] [{MachineName}] [{SourceContext}] {RequestId} {CorrelationId} {Message}{NewLine}{Exception}{properties}"
            );
    
        // 创建新Logger并替换静态实例
        var newLogger = _loggerConfig.CreateLogger();
        Log.Logger = newLogger;
        _currentLogger = newLogger;
    }
    
  3. 结合配置监听
    如果你用的是ASP.NET Core,可以通过IOptionsMonitor<T>来监听配置变更,当logFolderFullPath更新时自动调用UpdateLogPath方法;如果是普通服务,就自己实现Consul配置的监听逻辑,触发更新。

方案二:使用Serilog.Sinks.Map动态路由(更优雅)

如果你不想手动管理Logger实例,可以用Serilog.Sinks.Map扩展,它能根据动态属性值自动路由日志到不同路径,无需替换Logger。

步骤拆解

  1. 安装NuGet包
    先安装Serilog.Sinks.Map包,这个扩展专门用来处理动态路径的场景。

  2. 初始化时配置Map sink
    我们用一个动态的LogPath属性来指定日志路径,同时添加一个自定义Enricher,每次日志事件触发时都会从Consul获取最新的路径:

    // 自定义Enricher,负责从Consul获取最新日志路径
    public class DynamicLogPathEnricher : ILogEventEnricher
    {
        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
        {
            // 这里替换成你从Consul获取最新路径的逻辑
            var currentLogPath = GetLatestLogPathFromConsul();
            logEvent.AddPropertyIfAbsent(propertyFactory.CreateProperty("LogPath", currentLogPath));
        }
    }
    
    // 初始化Logger
    public static void InitLogger(long fileSizeLimitBytes, string applicationName)
    {
        Log.Logger = new LoggerConfiguration()
            .Enrich.With<DynamicLogPathEnricher>() // 添加动态路径Enricher
            .WriteTo.Map(
                "LogPath", // 根据这个属性的值路由
                (logPath, writeTo) => writeTo.File(
                    Path.Combine(logPath.ToString(), $"{applicationName}_.txt"),
                    LogEventLevel.Error,
                    shared: true,
                    fileSizeLimitBytes: fileSizeLimitBytes,
                    rollOnFileSizeLimit: true,
                    rollingInterval: RollingInterval.Day,
                    outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] [{MachineName}] [{SourceContext}] {RequestId} {CorrelationId} {Message}{NewLine}{Exception}{properties}"
                )
            )
            .CreateLogger();
    }
    
  3. 配置变更自动生效
    当Consul里的路径更新后,DynamicLogPathEnricher会自动获取到新路径,后续的日志就会自动写入新路径,完全不需要手动干预。

关键注意事项

  • 不管用哪种方案,Log.CloseAndFlush()都很重要(方案一里必须调用,方案二里如果需要切换路径时也可以手动调用一次确保旧文件写入完成),它能释放旧文件的句柄,避免文件被占用无法删除。
  • 如果你的服务还有其他sink(比如控制台、数据库),在重新构建LoggerConfiguration时要确保保留这些sink的配置,不要只保留File sink。

内容的提问来源于stack exchange,提问作者Darshan

火山引擎 最新活动