Serilog.Enrichers.Dynamic

Enriches Serilog events with information that you specify dynamically. There are a lot of great specific enrichers but none that let you pull any information from the context of your application and/or request.

Breaking changes. I made some changes to the parameter names and ordering to keep it consistent with some of the other enrichers. In the future I'll bump the major version.

To use the enricher, first install the NuGet package:

Install-Package Serilog.Enrichers.Dynamic

Then, apply the enricher to your LoggerConfiguration:

Log.Logger = new LoggerConfiguration()
    .Enrich.WithDynamicProperty("MyProperty", ()=> {
    	return AppContext.GetSomething(); 
    	}, enrichWhenNullOrEmptyString: false,destructureObjects: false, minimumLevel: LogEventLevel.Fatal
    // ...other configuration...
    .CreateLogger();

or for instance if you wanted to log the entire Service Stack Session:

Log.Logger = new LoggerConfiguration()
.Enrich.WithDynamicProperty("Session", () => {
  var propVal = "";
  if (HostContext.AppHost == null) return null; ;
    var req = HostContext.TryGetCurrentRequest();
    if (req != null && req.GetSession().IsAuthenticated)
    {
      propVal = req.GetSession().ToJson();  // prob not the best idea but hey
    }
    return !String.IsNullOrEmpty(propVal) ? propVal : null;
}).CreateLogger();

Perhaps you want to include a property in the log that would cause an alert to be issued to you from your centralized logging system:

Log.Logger = new LoggerConfiguration()
   .Enrich.WithDynamicProperty("SendAlert", () =>
         {
             var req = HostContext.TryGetCurrentRequest();
             if (req.GetType().HasAttribute<AlertOnErrorAttribute>())
             {
                 return "true";
             }
             return null;
         }, enrichWhenNullOrEmptyString: false)
}).CreateLogger();

[AlertOnError]
public void Post(SomeRequest request) {
  // processing that might fail and this is important so we alert 
}

Included enrichers

The package includes:

WithDynamicProperty( this LoggerEnrichmentConfiguration enrichmentConfiguration, string name, Func<string> valueProvider, bool destructureObjects=false, bool enrichWhenNullOrEmptyString = false, LogEventLevel minimumLevel= LogEventLevel.Verbose) - adds a func delegate that you define to log whatever you require

sbosell/serilog-enrichers-dynamic

Serilog.Enrichers.Dynamic

Included enrichers