refactor logging

Directory.Build.props

@@ -1,21 +1,12 @@
 <Project>
   <ItemGroup>
-    <PackageReference Include="Meziantou.Analyzer" Version="1.0.688" Condition="$(MSBuildProjectExtension) == '.csproj'" PrivateAssets="all">
+
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
     <PackageReference
       Include="StyleCop.Analyzers"
       Version="1.2.0-beta.354"
       PrivateAssets="all"
       Condition="$(MSBuildProjectExtension) == '.csproj'"
     />
-    <PackageReference
-      Include="SonarAnalyzer.CSharp"
-      Version="8.29.0.36737"
-      PrivateAssets="all"
-      Condition="$(MSBuildProjectExtension) == '.csproj'"
-    />
 
     <PackageReference
       Include="Roslynator.Analyzers"
@@ -47,18 +38,20 @@
       PrivateAssets="all"
       Condition="$(MSBuildProjectExtension) == '.csproj'"
     />
+    <PackageReference
+      Include="SerilogAnalyzer"
+      Version="0.15.0"
+      PrivateAssets="all"
+      Condition="$(MSBuildProjectExtension) == '.csproj'"
+    />
 
-  </ItemGroup>
+    <PackageReference
+      Include="Meziantou.Analyzer"
+      Version="1.0.723"
+      PrivateAssets="all"
+      Condition="$(MSBuildProjectExtension) == '.csproj'"
+    />
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="6.0.1">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.1">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
   </ItemGroup>
 
 </Project>

src/BuildingBlocks/HealthCheck/Extensions.cs

@@ -26,7 +26,7 @@ public static class Extensions
         var healthChecksBuilder = services.AddHealthChecks()
             .AddSqlServer(sqlOptions.DefaultConnection)
             .AddRabbitMQ(rabbitConnectionString: $"amqp://{rabbitMqOptions.UserName}:{rabbitMqOptions.Password}@{rabbitMqOptions.HostName}")
-            .AddElasticsearch(logOptions.ElasticUri);
+            .AddElasticsearch(logOptions.Elastic.ElasticServiceUrl);
 
         if (mongoOptions.ConnectionString is not null)
             healthChecksBuilder.AddMongoDb(mongoOptions.ConnectionString);

src/BuildingBlocks/Logging/ElasticOptions.cs

@@ -0,0 +1,8 @@
+namespace BuildingBlocks.Logging;
+
+public class ElasticOptions
+{
+    public bool Enable { get; set; }
+    public string ElasticServiceUrl { get; set; }
+    public string ElasticSearchIndex { get; set; }
+}

src/BuildingBlocks/Logging/Extensions.cs

@@ -1,47 +1,67 @@
-using System.Reflection;
+using System.Text;
 using BuildingBlocks.Web;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;
-using Microsoft.Extensions.Hosting;
 using Serilog;
-using Serilog.Enrichers.Span;
 using Serilog.Events;
 using Serilog.Exceptions;
 using Serilog.Sinks.Elasticsearch;
 using Serilog.Sinks.SpectreConsole;
 
-namespace BuildingBlocks.Logging;
+namespace BuildingBlocks.Logging
-
-public static class Extensions
 {
+    public static class Extensions
+    {
         public static WebApplicationBuilder AddCustomSerilog(this WebApplicationBuilder builder)
         {
-        builder.Host.UseSerilog((context, loggerConfiguration) =>
+            builder.Host.UseSerilog((context, services, loggerConfiguration) =>
             {
                 var environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
-            var loggOptions = context.Configuration.GetSection(nameof(LogOptions)).Get<LogOptions>();
+                var logOptions = context.Configuration.GetSection(nameof(LogOptions)).Get<LogOptions>();
                 var appOptions = context.Configuration.GetSection(nameof(AppOptions)).Get<AppOptions>();
 
-            var logLevel = Enum.TryParse<LogEventLevel>(loggOptions.Level, true, out var level)
+
+                var logLevel = Enum.TryParse<LogEventLevel>(logOptions.Level, true, out var level)
                     ? level
                     : LogEventLevel.Information;
 
                 loggerConfiguration
-                .WriteTo.Elasticsearch(new ElasticsearchSinkOptions(new Uri(loggOptions.ElasticUri))
+                    .MinimumLevel.Is(logLevel)
+                    .WriteTo.SpectreConsole(logOptions.LogTemplate, logLevel)
+                    .MinimumLevel.Override("Microsoft", LogEventLevel.Information)
+                    // Only show ef-core information in error level
+                    .MinimumLevel.Override("Microsoft.EntityFrameworkCore", LogEventLevel.Error)
+                    // Filter out ASP.NET Core infrastructure logs that are Information and below
+                    .MinimumLevel.Override("Microsoft.AspNetCore", LogEventLevel.Warning)
+                    .Enrich.WithExceptionDetails()
+                    .Enrich.FromLogContext()
+                    .ReadFrom.Configuration(context.Configuration);
+
+                if (logOptions.Elastic.Enable)
+                {
+                    loggerConfiguration.WriteTo.Elasticsearch(
+                        new ElasticsearchSinkOptions(new Uri(logOptions.Elastic.ElasticServiceUrl))
                         {
                             AutoRegisterTemplate = true,
                             IndexFormat =
                                 $"{appOptions.Name}-{environment?.ToLower().Replace(".", "-")}-{DateTime.UtcNow:yyyy-MM}"
-                })
+                        });
-                .WriteTo.SpectreConsole(loggOptions.LogTemplate, logLevel)
+                }
-                .MinimumLevel.Override("Microsoft.EntityFrameworkCore", LogEventLevel.Error)
+
-                .Enrich.WithSpan()
+                if (logOptions.File.Enable)
-                .Enrich.WithExceptionDetails()
+                {
-                .Enrich.FromLogContext()
+                    var path = string.IsNullOrWhiteSpace(logOptions.File.Path) ? "logs/.txt" : logOptions.File.Path;
-                .ReadFrom.Configuration(context.Configuration);
+                    if (!Enum.TryParse<RollingInterval>(logOptions.File.Interval, true, out var interval))
+                    {
+                        interval = RollingInterval.Day;
+                    }
+
+                    loggerConfiguration.WriteTo.File(path, rollingInterval: interval, encoding: Encoding.UTF8,
+                        outputTemplate: logOptions.LogTemplate);
+                }
             });
 
             return builder;
         }
+    }
 }

src/BuildingBlocks/Logging/FileOptions.cs

@@ -0,0 +1,8 @@
+namespace BuildingBlocks.Logging;
+
+public class FileOptions
+{
+    public bool Enable { get; set; }
+    public string Path { get; set; }
+    public string Interval { get; set; }
+}

src/BuildingBlocks/Logging/LogOptions.cs

@@ -0,0 +1,10 @@
+namespace BuildingBlocks.Logging
+{
+    public class LogOptions
+    {
+        public string Level { get; set; }
+        public ElasticOptions Elastic { get; set; }
+        public FileOptions File { get; set; }
+        public string LogTemplate { get; set; }
+    }
+}

src/BuildingBlocks/Logging/LoggerOptions.cs

@@ -1,8 +0,0 @@
-namespace BuildingBlocks.Logging;
-
-public class LogOptions
-{
-    public string Level { get; set; }
-    public string LogTemplate { get; set; }
-    public string ElasticUri { get; set; }
-}

src/Services/Booking/src/Booking.Api/appsettings.json

@@ -3,9 +3,17 @@
     "Name": "Booking-Service"
   },
   "LogOptions": {
-    "Level": "Information",
+    "Level": "information",
     "LogTemplate": "{Timestamp:HH:mm:ss} [{Level:u4}] {Message:lj}{NewLine}{Exception}",
-    "ElasticUri": "http://localhost:9200"
+    "Elastic": {
+      "Enable": true,
+      "ElasticServiceUrl": "http://localhost:9200"
+    },
+    "File": {
+      "enable": false,
+      "path": "logs/logs.txt",
+      "interval": "day"
+    }
   },
   "Jwt": {
     "Authority": "https://localhost:5005",

src/Services/Flight/src/Flight.Api/appsettings.json

@@ -3,9 +3,17 @@
     "Name": "Flight-Service"
   },
   "LogOptions": {
-    "Level": "Information",
+    "Level": "information",
     "LogTemplate": "{Timestamp:HH:mm:ss} [{Level:u4}] {Message:lj}{NewLine}{Exception}",
-    "ElasticUri": "http://localhost:9200"
+    "Elastic": {
+      "Enable": true,
+      "ElasticServiceUrl": "http://localhost:9200"
+    },
+    "File": {
+      "enable": false,
+      "path": "logs/logs.txt",
+      "interval": "day"
+    }
   },
   "ConnectionStrings": {
     "DefaultConnection": "Server=.\\sqlexpress;Database=FlightDB;Trusted_Connection=True;MultipleActiveResultSets=true"

src/Services/Identity/src/Identity.Api/appsettings.json

@@ -12,9 +12,17 @@
     "Password": "guest"
   },
   "LogOptions": {
-    "Level": "Information",
+    "Level": "information",
     "LogTemplate": "{Timestamp:HH:mm:ss} [{Level:u4}] {Message:lj}{NewLine}{Exception}",
-    "ElasticUri": "http://localhost:9200"
+    "Elastic": {
+      "Enable": true,
+      "ElasticServiceUrl": "http://localhost:9200"
+    },
+    "File": {
+      "enable": false,
+      "path": "logs/logs.txt",
+      "interval": "day"
+    }
   },
   "PersistMessageOptions": {
     "Interval": 30,

src/Services/Passenger/src/Passenger.Api/appsettings.json

@@ -20,9 +20,17 @@
     "Password": "guest"
   },
   "LogOptions": {
-    "Level": "Information",
+    "Level": "information",
     "LogTemplate": "{Timestamp:HH:mm:ss} [{Level:u4}] {Message:lj}{NewLine}{Exception}",
-    "ElasticUri": "http://localhost:9200"
+    "Elastic": {
+      "Enable": true,
+      "ElasticServiceUrl": "http://localhost:9200"
+    },
+    "File": {
+      "enable": false,
+      "path": "logs/logs.txt",
+      "interval": "day"
+    }
   },
   "PersistMessageOptions": {
     "Interval": 30,