mrxrsd / dynamic-serilog-switch

Dynamic Serilog Switch

Dynamic Serilog Switch is a extension for serilog that expose a service to retrieve and change LoggingLevelSwitches at runtime.

Getting started

1. Add the NuGet package as a dependency of your project either with the package manager.

2. Configure your serilog config file using switches as describe in Serilog Docs.

{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console" ],
    "LevelSwitches": {
      "$mainSwitch": "Verbose",
      "$appSwitch":  "Verbose"
    },
    "MinimumLevel": {
      "ControlledBy": "$mainSwitch",
      "Default": "Information",
      "Override": {
        "AspnetCoreSample": "$appSwitch",
        "Microsoft": "Warning"
      }
    },
    "WriteTo": [
      { "Name": "Console" }
    ]
  }
}

2. In your Program class, call Configure overload that exposes LoggingLevelSwitchConfiguration:

    public static void Main(string[] args)
    {
        var configuration = new ConfigurationBuilder()
                                .AddJsonFile("serilog.json")
                                .Build();

        Log.Logger = new LoggerConfiguration()
                            .ReadFrom.Configuration(configuration, out var llsConfig)
                            .CreateLogger();

        CreateHostBuilder(args, llsConfig).Build().Run();
        
    }

3. Call AddDynamicLoggingLevel passing serilog logger and switches configuration. That method will inject ISerilogLogSwitcherService using dotnet service collection.

        Host.CreateDefaultBuilder(args)
            .UseSerilog()
            .AddDynamicLoggingLevel(Log.Logger, llsConfig)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });

4. [Optional] Call UseDynamicLoggingLevelHelperPage to inject a middleware that you can list all switches and change their logging levels.

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IHostApplicationLifetime lifetime)
        {
            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

            app.UseDynamicLoggingLevelHelperPage();
        }

SerilogLogSwitcherService

    public interface ISerilogLogSwitcherService
    {
        void SetLevel(string prefix, LogEventLevel level);
        void SetLevel(Guid guid, LogEventLevel level);
        IList<DynamicLoggingLevelSwitch> GetSwitches();

    }

    public class DynamicLoggingLevelSwitch
    {
        public Guid Id { get; set; }
        public string SwitchName { get; set; }
        public List<string> Prefixes { get; set; }
    }

Middleware

List all switches

Just call Dynamic Serilog Switch Middleware as config in your startup. (default: /dynamic-serilog-switch)

[GET] http://base-url/dynamic-serilog-switch

Change Logging Level

[GET] http://base-url/dynamic-serilog-switch/{id}/{logging-event}

Example: http://base-url/dynamic-serilog-switch/87d01cbf-a6d9-4488-b90a-3f6b629bbdc6/Information

License

MIT