We Keep Coding

Add custom ILogger to ASP.NET Core Web API

I have a central Project which generates all the Loggers for the subprojects. (And does a lot of other stuff which is not nessesary for my problem)
One of the Subprojects is an ASP.NET Web API. Now I want to add the Logger which is generated by a Logger Factory (see below) to the WebApplication. The problem is that the current version of WebApplication doesn't accept ILoggers...
(I use .Net 6)
The following function generates my Logger Factory:
private ILoggerFactory CreateLoggerFactory()
{
IConfiguration configSerilog = new ConfigurationBuilder()
.AddJsonFile("appsettings.json", false, false)
.Build();
Serilog.Core.Logger serilogLogger = new LoggerConfiguration()
.ReadFrom.Configuration(configSerilog)
.Enrich.WithProperty("ComponentShortcuts", _componentShortcuts)
.CreateLogger();
ILoggerFactory loggerFactory = new LoggerFactory()
.AddSerilog(serilogLogger);
return loggerFactory;
}
The only thing I can do at the moment is to delete the default Loggers:
var builder = WebApplication.CreateBuilder();
builder.Logging.ClearProviders();
The problem is that I don't know how to add my Logger, because there is no AddLogger() function.
(I have no idea how to convert the ILogger or if there is something else that I can generate with the Logger Factory that helps me.)
I hope you can help me :)

So I faced this same issue 2 days ago with logging in .net 6 web api. And I found a solution to it that worked for me, i-e; By using LoggerConfiguration.
Although I'm still looking for a way to do it by LoggerFactory I'll post it as soon as I figure it out. Till then I hope this helps you.
Here's my code;
Program.cs
builder.Logging.ClearProviders();
var configuration = new ConfigurationBuilder()
.AddJsonFile("appsettings.json")
.Build();
var logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
//.MinimumLevel.Override("Microsoft", LogEventLevel.Error)
//.MinimumLevel.Override("Microsoft.AspNetCore",LogEventLevel.Error)
//.MinimumLevel.Override("Serilog", LogEventLevel.Error)
.Enrich.FromLogContext()
.Enrich.WithClientIp("CF-Connecting-IP")
.Enrich.WithClientAgent()
.CreateLogger();
Log.Logger = logger;
builder.Logging.AddSerilog(logger);
builder.Host.UseSerilog();
Then add the middleware
app.UseSerilogRequestLogging();
appsettings.json (I'm logging to Console and Sql Server also (In case you want to do it.))
"Serilog": {
"Using": [ "Serilog.Enrichers.ClientInfo", "Serilog.Sinks.MSSqlServer" ],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Warning",
"System": "Warning",
"System.Net.Http.HttpClient": "Warning"
}
},
"Enrich": [
"FromLogContext",
"WithMachineName",
"WithClientIp",
"WithClientAgent",
{
"Name": "WithClientIp",
"Args": {
"xForwardHeaderName": "CF-Connecting-IP"
}
}
],
"WriteTo": [
{
"Name": "Console"
},
{
"Name": "MSSqlServer",
"Args": {
"connectionString": "",
"sinkOptionsSection": {
"tableName": "TableName",
"autoCreateSqlTable": true
},
"restrictedToMinimumLevel": "Information",
"columnOptionsSection": {
"primaryKeyColumnName": "",
"addStandardColumns": [ "LogEvent", "SourceContext" ],
"additionalColumns": [
{
"ColumnName": "ClientIPAddress",
"PropertyName": "UserIp",
"DataType": "nvarchar"
}
]
}
}
}
]
}
Feel free to let me know if you have any doubts. And don't forget to install the relevant nuget packages.
All the best!! :)

Serilog file name UTC Date format

I want to use UTC DateTime in Serilog filename. I am using the below configuration for serilog in my appseting.json file.
"Serilog": {
"Using": [],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning"
}
},
"Enrich": [
"FromLogContext",
"WithMachineName",
"WithProcessId",
"WithThreadId"
],
"WriteTo": [
{
"Name": "Console"
},
{
"Name": "File",
"Args": {
"path": "Logs\\log-.json",
"formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact",
"rollingInterval": "Hour",
"shared": true
}
}
]
}
and below is the program.cs file code which I use for serilog.
public static void Main(string[] args)
{
var configuration = new ConfigurationBuilder()
.AddJsonFile("appsettings.json").Build();
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.CreateLogger();
try
{
CreateHostBuilder(args).Build().Run();
}
catch (Exception e)
{
Log.Fatal(e, "The Application failed to start correctly");
}
finally
{
Log.CloseAndFlush();
}
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args).UseSerilog()
.ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
Currently, serilog producing the log file name as log-2020091323.json which is not UTC DateTime.
I'm using asp.net core 3.1.

You can use Install-Package Serilog.Sinks.Map nuget package and configet it in Serilog setup to archive this as in below code example
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Information()
// Ex: UtcDateTime value '202009201010'
.WriteTo.Map("UtcDateTime", DateTime.UtcNow.ToString("yyyyMMddHHmm")
, (UtcDateTime, wt) => wt.File($"logs/log-{UtcDateTime}.txt"))
.CreateLogger();
Log.Information("Hello, Serilog!");
Log.CloseAndFlush(); // Ex: log file name 'log-202009201010.txt'
This code save logs to new file each minute if you need to configure it for each hour use DateTime.UtcNow.ToString("yyyyMMddHH"), or DateTime.UtcNow.ToString("yyyyMMdd") for each day.

Is there a way to set Serilog formatter variables via appsettings.json?

I have the following appsettings.json configuration:
{
"Serilog": {
"Using": [],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning"
}
},
"Enrich": [ "FromLogContext", "WithMachineName" ],
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "C:\\Logs\\log.json",
"formatter": "Serilog.Formatting.Elasticsearch.ElasticsearchJsonFormatter, Serilog.Formatting.Elasticsearch"
}
}
]
}
}
What I am trying to configure in the above appsettings.json file would be represented in C# as something like this:
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.WriteTo.File(new ElasticsearchJsonFormatter(inlineFields:true, renderMessageTemplate: false), #"C:\logs\log.json")
.CreateLogger();
I need to set "inlineFields" equal to true and "renderMessageTemplate" equal to false as overrides in my appsettings.json file on the ElasticsearchJsonFormatter instance. Is there a way to do that in the appsettings.json file so that I can keep my configuration out of C#?

I asked this question on GitHub: https://github.com/serilog/serilog-sinks-file/issues/138
No way :(

They added this feature in Serilog.Settings.Configuration -v 3.3.0-dev-00291.
Serilog__WriteTo__Console__Name=Console
Serilog__WriteTo__Console__Args__formatter__type="Serilog.Templates.ExpressionTemplate, Serilog.Expressions"
Serilog__WriteTo__Console__Args__formatter__template="[{#t:HH:mm:ss} {#l:u3} {Coalesce(SourceContext, '<none>')}] {#m}\n{#x}"
[22:38:40 INF My.Foo.FooClient] HELLO WORLD
links
https://www.nuget.org/packages/Serilog.Settings.Configuration/3.3.0-dev-00291
https://github.com/serilog/serilog-settings-configuration/pull/281

Sentry configuration in appsettings.json with Serilog in .Net Core 3 Console App

I'm using the following code to configure Sentry with Serilog in my .Net Core Console application:
return new LoggerConfiguration()
.MinimumLevel.Debug()
.WriteTo.Sentry(o =>
{
o.MinimumBreadcrumbLevel = LogEventLevel.Error;
o.MinimumEventLevel = LogEventLevel.Error;
o.Dsn = new Dsn(configuration.GetValue<string>("Sentry:Dsn"));
o.Debug = false;
o.AttachStacktrace = true;
o.SendDefaultPii = true;
})
.CreateLogger();
Now I would like to move all this configuration in the appsettings.json file because I need to have a different configuration in Develop environment and Production:
Example:
"Sentry": {
"Dsn": "<dsn>",
"IncludeRequestPayload": true,
"IncludeActivityData": true,
"Debug": false,
"DiagnosticsLevel": "Debug",
"MinimumBreadcrumbLevel": "Debug",
"MinimumEventLevel": "Warning"
},
Is it possible to read the whole configuration from there?
update
I try the following configuration in my Console application:
static void Main(string[] args)
{
using (SentrySdk.Init("<dsn>"))
{
// my code
}
...
serviceCollection.AddSingleton<ILogger>(s =>
{
return new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.CreateLogger();
});
appsettings:
"Serilog": {
"Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.Sentry" ],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning",
"Sentry": "Information"
}
},
"Enrich": [ "FromLogContext" ],
"WriteTo": [
{
"Name": "Console"
},
{
"Name": "Sentry",
"Args": {
"Dsn": "<dsn>",
"MinimumBreadcrumbLevel": "Info",
"MinimumEventLevel": "Info",
"AttachStackTrace": true,
"Debug": true,
"DiagnosticsLevel": "Info"
}
}
]
But SentrySdk.Init("<dsn>") needs a DSN and it won't read it from appsettings!
Is this the way?

Serilog is unaware of the ASP.NET Core configuration. At least in a way that would bind specific sections of the configuration object to its extensions.
If you're using ASP.NET Core, I assume you're also using Sentry.AspNetCore. It's advised you do. In which case you'd need to pass configuration to it too.
NuGetTrends which is an open source project uses Serilog with ASP.NET Core while using the appsettings.json file to configure things.
Here's the Program.cs setting up Sentry, Serilog and ASP.NET Core.
Note that the configuration as you mentioned (with Sentry as a key) will be picked up by Sentry.AspNetCore but not by Sentry.Serilog (which is decoupled from ASP.NET Core).
You can configure the latter, which is a normal Serilog sink like:
"Serilog": {
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning",
"Sentry": "Information"
}
},
"WriteTo": [
{
"Name": "Sentry",
"Args": {
"MinimumBreadcrumbLevel": "Debug",
"MinimumEventLevel": "Warning"
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName" ]
}
I suggest leaving the DSN and other settings as you did, on the Sentry key, which makes the ASP.NET Core initialize the SDK, it will also leverage the Serilog integration.

Serilog setup for Asp.Net Core 2.0.1 not producing logs

I am trying to set up Serilog as my logger in a multi project solution using Asp.Net Core 2.0.1, EF 2.0.1 and MVC 6.
I have set up Serilog, mostly following the guidelines from this blog post
Set up Serilog post
There is a problem with the json in that post, which I've corrected and is shown here
appsettings.json file
{
"ApplicationConfiguration": {
"ConnectionStrings": {
"DevelopmentConnection": "Server=(localdb)\\mssqllocaldb;Database=TestingConfigurationNetCoreTwo_Development;Trusted_Connection=True;MultipleActiveResultSets=true"
},
"ApplicationInfo": {
"VersionNumber": "1.0.0",
"Author": "Jimbo",
"ApplicationName": "CustomTemplate",
"CreatedOn": "November 20, 2017"
},
"Serilog": {
"Using": [
"Serilog.Sinks.RollingFile",
"Serilog.Sinks.Async",
"Serilog.Sinks.ApplicationInsights",
"Serilog.Sinks.Console",
"Serilog.Sinks.Seq"
],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning"
}
},
"WriteTo": [
{
"Name": "Async",
"Args": {
"configure": [
{
"Name": "RollingFile",
"Args": { "pathFormat": "Logs/log-{Date}.log" }
}
]
}
}
],
"Enrich": ["FromLogContext", "WithMachineName", "WithThreadId"],
"Properties": {
"Application": "CustomTemplate"
}
}
}
}
I have the logger configuration work in the Main method of Program.cs
public static int Main(string[] args)
{
var currentEnv = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
var configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json")
.AddJsonFile($"appsettings.{currentEnv}.json", optional: true)
.AddEnvironmentVariables()
.Build();
//Configure logger
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
//do this for now
//TODO:figure out how to add to Serilog config in appsettings.json
.WriteTo.Seq("http://localhost:5341")
.CreateLogger();
Log.Information("Logger created");
try
{
Log.Information("Starting web host");
BuildWebHost(args).Run();
return 0;
}
catch (Exception ex)
{
Log.Fatal(ex, "Web Host terminated unexpectedly");
return 1;
}
finally
{
Log.CloseAndFlush();
}
//BuildWebHost(args).Run();
}
public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseStartup<Startup>()
.Build();
And in my Startup method
services.AddLogging(loggingBuilder =>
loggingBuilder.AddSerilog(dispose: true));
I was assuming Serilog would create the Logs folder once I ran the application, but no Log folder or logs. I added a Logs folder to both the root of the solution, and the web app project and ran it again. No logs. The blog post author suggested looking in the machines root folder. I looked both in C and OneDrive main folders (Solution Files stored on OneDrive) but there were no logs there either.
I then noticed a stack trace warning
System.IO.FileNotFoundException occurred
HResult=0x80070002
Message=The configuration file 'appsettings.json' was not found and is not optional. The physical path is 'C:\Users\OneDrive\TestingConfigurationAspNetCore2\TestMvcApp\bin\Debug\netcoreapp2.0\appsettings.json'.
Source=
StackTrace:
at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load()
at Microsoft.Extensions.Configuration.ConfigurationRoot..ctor(IList`1 providers)
at Microsoft.Extensions.Configuration.ConfigurationBuilder.Build()
I was getting this warning before, which is why I added the set bath path method in the configuration set up, because the application was failing at the code line
.AddJsonFile("appsettings.json")
which was fairly obvious because in the bin folder the file isn't called appsettings.json, its called TestMvcApp.runtimeconfig.json.
Once I added .SetBasePath, the code ran through so I put a breakpoint after the configuration setup. The configuration object contains all the settings from my appsettings.json file, so why I am getting that stack trace error? I don't know but I'll bet a dollar it is why there are no logs (no log messages appear in the console either)
Any help on why the stack trace error or why there are no log messages being written to the log file or displayed on the console would be most appreciated.

which was fairly obvious because in the bin folder the file isn't
called appsettings.json, its called TestMvcApp.runtimeconfig.json.
TestMvcApp.runtimeconfig.json is not your appsettings.json, it's a runtime configuration file as it's clear from the file name.
I bet that your appsettings.json is just not copied to the output directory during the build. To fix that select appsettings.json in Visual Studio Solution explorer, in context menu select properties and set 'Copy to Output Directory' to 'Copy always' or 'Copy if newer':
Also your json configuration has several issues:
Serilog section should not be inside ApplicationConfiguration section. It should be on the same level, i.e top-level section.
You also has suspicious WriteTo section with one sink (RollingFile) inside another (Async). Check here sample json configuration for Serilog.
In order to use all those sinks (Serilog.Sinks.RollingFile, Serilog.Sinks.Console) you should install corresponding sink NuGets: Serilog.Sinks.RollingFile, Serilog.Sinks.Console, etc.
Here is configuration file (with RollingFile sink only) that works fine for me:
{
"ApplicationConfiguration": {
"ConnectionStrings": {
"DevelopmentConnection": "Server=(localdb)\\mssqllocaldb;Database=TestingConfigurationNetCoreTwo_Development;Trusted_Connection=True;MultipleActiveResultSets=true"
},
"ApplicationInfo": {
"VersionNumber": "1.0.0",
"Author": "Jimbo",
"ApplicationName": "CustomTemplate",
"CreatedOn": "November 20, 2017"
}
},
"Serilog": {
"Using": [
"Serilog.Sinks.RollingFile"
],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning"
}
},
"WriteTo": [
{
"Name": "RollingFile",
"Args": { "pathFormat": "c:\\log-{Date}.log" }
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
"Properties": {
"Application": "CustomTemplate"
}
}
}

The accepted answer only logged some messages for my project. I'm not sure why. Ondrej Balas's approach worked better for me.
Install these Nuget packages:
Serilog
Serilog.AspNetCore
Serilog.Settings.Configuration
Serilog.Sinks.Console
Serilog.Sinks.RollingFile
Program.cs needs .UseSerilog() added:
public static void Main(string[] args)
{
BuildWebHost(args).Run();
}
public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureLogging((hostingContext, logging) =>
{
logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
})
.UseStartup<Startup>()
.UseSerilog()
.Build();
Startup.cs needs a couple of changes
one in the constructor:
public Startup(IConfiguration configuration)
{
Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(configuration).CreateLogger();
Configuration = configuration;
}
another in Configure():
loggerFactory.AddSerilog();
if (env.IsDevelopment())
{
loggerFactory.AddConsole(Configuration.GetSection("Logging"));
}
appsettings.json needs a Serilog config entry in root:
"Serilog": {
"Using": [ "Serilog.Sinks.Console" ],
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"System": "Warning"
}
},
"WriteTo": [
{ "Name": "Console" },
{
"Name": "RollingFile",
"Args": {
"pathFormat": "logs\\log-{Date}.log",
"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] [{SourceContext}] {Message}{NewLine}{Exception}"
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
"Properties": {
"Application": "My Application"
}
}