pm4net/serilog-enrichers-callerinfo

A simple Serilog enricher to add information about the calling method.

Serilog.Enrichers.CallerInfo

A simple Serilog enricher to add information about the calling method. Loosely based on Serilog.Enrichers.WithCaller, but with the properties split up for a consistent format that can be parsed automatically.

Performance may be low due the usage of reflection to obtain assembly and method information, as well as the retrieval of the current stacktrace whenever a new log event is added.

To get the actual method that emitted the log event, the stack trace is traversed and the first method that is in a matching assembly is considered the correct one.

To configure which assemblies are the correct one, one can either use the configuration method with assemblyPrefix or the one that directly accepts a collection of fully qualified assembly names. When passing in only a prefix, the assembly that calls the configuration method is recursively analyzed for referenced assemblies and whether they match the prefix. If you e.g. have a solution with projects being called MySolution.Web, MySolution.Domain, etc., you can limit the included assemblies by passing in the prefix MySolution. Be aware that the assembly from which you configure the logger must also have the correct prefix, otherwise no assemblies will be considered and the enricher won't work. To define a custom assembly from which to start scanning referenced assemblies (instead of the calling assembly), you can define the optional startingAssembly parameter, which must be a fully qualified assembly name.

Usage

// With assembly prefix
Log.Logger = new LoggerConfiguration()
    .Enrich.WithCallerInfo(
        includeFileInfo: true, 
        assemblyPrefix: "MySolution.",
        prefix: "myprefix_",
        filePathDepth: 3,
        excludedPrefixes: new List<string> { "SomeOtherProject." })
    .WriteTo.InMemory()
    .CreateLogger();

// With fully qualified assembly names
Log.Logger = new LoggerConfiguration()
    .Enrich.WithCallerInfo(
        includeFileInfo: true, 
        allowedAssemblies: new List<string> { "Serilog.Enrichers.CallerInfo.Tests" }, 
        prefix: "myprefix_")
    .WriteTo.InMemory()
    .CreateLogger();

Or via appsettings.json (using Serilog.Settings.Configuration):

With assembly prefix (when configuring via appsettings.json, you have to define the starting assembly, as the calling assembly is otherwise Serilog.Settings.Configuration (see #1)):

"Serilog": {
    "Enrich": [
      {
        "Name": "WithCallerInfo",
        "Args": {
          "includeFileInfo": "true",
          "assemblyPrefix": "MySolution.",
          "startingAssembly": "MySolution.Web"
        }
      }
    ]
  }

With fully qualified assembly names:

"Serilog": {
    "Enrich": [
      {
        "Name": "WithCallerInfo",
        "Args": {
          "includeFileInfo": "true",
          "allowedAssemblies": [ "Assembly1", "Assembly2" ],
          "prefix": "myprefix_"
        }
      }
    ]
  }

Properties

The following properties are added:

Property	Description	Depends on
Method	The calling method
Namespace	The namespace of the calling method (including class name)
SourceFile	The path of the source file of the calling method	includeFileInfo and filePathDepth
LineNumber	The line number of the calling method	includeFileInfo
ColumnNumber	The column number of the calling method	includeFileInfo

serilog-enrichers-callerinfo's Issues

Enrich not working with new 1.0.2 version

Hi,

I've updated to ver 1.0.2 and the enricher is no longer working.

i'm using .net core 7 and configuring the enricher in program.cs like:

.Enrich.WithCallerInfo(includeFileInfo: false, assemblyPrefix: "MyAssemblyName.")

When I downgrade back to 1.0.1 it works perfectly without any changes to the above code.

Regards
Raff

How do I configure WithCallerInfo via appsettings.json?

Hi,
I'm trying to configure WithCallerInfo via appsettings.json (Serilog.Settings.Configuration). If I configure it via code everything works fine. I have verified that my appsettings.json is actually parsed and used to configure Serilog by manipulating the log template.

This is my configuration:

{
  "AllowedHosts": "*",
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.Debug" ],
    "MinimumLevel": "Debug",
    "WriteTo": [
      {
        "Name": "Console",
        "Args": {
          "outputTemplate": "{Level:u} {Timestamp:yyyy-MM-dd HH:mm:ss.fff} {MachineName} {ThreadId} {SourceContext} {Method} {Message:lj}{NewLine}{Exception}"
        }
      },
      {
        "Name": "Debug",
        "Args": {
          "outputTemplate": "{Level:u} {Timestamp:yyyy-MM-dd HH:mm:ss.fff} {MachineName} {ThreadId} {SourceContext} {Method} {Message:lj}{NewLine}{Exception}"
        }
      }
    ],
    "Enrich": [
      "FromLogContext",
      "WithMachineName",
      "WithThreadId",
      {
        "Name": "WithCallerInfo",
        "Args": {
          "includeFileInfo": "false",
          "assemblyPrefix": "MyAssembly.",
          "prefix": ""
        }
      }
    ],
    "Properties": {
      "Application": "MyApp"
    }
  }
}

Using the SelfLog I noticed that the prefix attribute must be present in the config even if it is optional in code, otherwise the Enricher is not found by Serilog.Settings.Configuration. However it seems no make no difference, the method name is never present in the logs. Any idea?

EDIT: The plot thickens. If I change the assemblyPrefix to "" then it prints "Enrich" as the Method name (as expected). But if I change it to MyAssembly in the json file then nothing is printed. If I configure it using .Enrich.WithCallerInfo(false, "MyAssembly") it works fine.