Simplified logging and added env vars to README

Author: kenkendk

Configs.cs

@@ -22,13 +22,6 @@
 
 namespace DuplicatiIngress;
 
-/// <summary>
-/// Represents the Serilog configuration
-/// </summary>
-/// <param name="SourceToken">The Source Token</param>
-/// <param name="Endpoint">The endpoint for the ingesting host</param>
-public record SerilogConfig(string SourceToken, string? Endpoint = null);
-
 /// <summary>
 /// Represents the Messaging configuration
 /// </summary>

DuplicatiIngress.csproj

@@ -7,15 +7,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BetterStack.Logs.Serilog" Version="1.1.0" />
     <PackageReference Include="MassTransit.SqlTransport.PostgreSQL" Version="8.4.1" />
 
     <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.6" />
 
-    <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
-    <PackageReference Include="Serilog.Enrichers.ClientInfo" Version="2.1.2" />
-    <PackageReference Include="Serilog.Sinks.Console" Version="6.0.0" />
-
     <PackageReference Include="KVPSButter" Version="0.0.3-beta" />
     <PackageReference Include="KVPSButter.S3" Version="0.0.11-alpha" />
     <PackageReference Include="KVPSButter.Postgres" Version="0.0.1-alpha" />
@@ -24,7 +19,8 @@
     <PackageReference Include="UuidExtensions" Version="1.2.0" />
     <PackageReference Include="RobotsTxtCore" Version="3.0.0" />
 
-      <PackageReference Include="SimpleSecurityFilter" Version="1.0.2" />
+    <PackageReference Include="SimpleSecurityFilter" Version="1.0.2" />
+    <PackageReference Include="CommonDuplicatiConsoleLogging" Version="1.0.1" />      
   </ItemGroup>
 
 </Project>

Program.cs

@@ -17,6 +17,7 @@
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
+using CommonLoggingConfig;
 using DuplicatiIngress;
 using MassTransit;
 using MassTransit.SqlTransport.PostgreSql;
@@ -25,33 +26,10 @@
 using Microsoft.IdentityModel.Tokens;
 using RobotsTxt;
 using Serilog;
-using Serilog.Core;
-using Serilog.Events;
 using SimpleSecurityFilter;
 
 var builder = WebApplication.CreateBuilder(args);
 
-var envConfig = builder.Configuration.GetRequiredSection("Environment").Get<EnvironmentConfig>()!;
-builder.Services.AddSingleton(envConfig);
-
-// Prepare logging
-var envLogLevel = builder.Configuration.GetValue<string>("Serilog:MinimumLevel:Default");
-var logLevelSwitch = new LoggingLevelSwitch(
-    !string.IsNullOrWhiteSpace(envLogLevel)
-        ? Enum.Parse<LogEventLevel>(envLogLevel)
-        : LogEventLevel.Information);
-
-var logConfiguration = new LoggerConfiguration()
-    .Enrich.FromLogContext()
-    .Enrich.WithClientIp()
-    .Enrich.WithCorrelationId(headerName: "X-Request-Id")
-    .Enrich.WithRequestHeader("X-Forwarded-For")
-    .Enrich.WithRequestHeader("User-Agent")
-    .MinimumLevel.ControlledBy(logLevelSwitch)
-    .WriteTo.Console();
-
-builder.Host.UseSerilog();
-
 // Support the untracked local environment variables file for development
 if (builder.Environment.IsDevelopment())
 {
@@ -66,25 +44,14 @@
 
 builder.Configuration.AddEnvironmentVariables();
 
+var envConfig = builder.Configuration.GetRequiredSection("Environment").Get<EnvironmentConfig>()!;
+builder.Services.AddSingleton(envConfig);
+
 var serilogConfig = builder.Configuration.GetSection("Serilog").Get<SerilogConfig>();
-if (!string.IsNullOrWhiteSpace(serilogConfig?.SourceToken))
-{
-    if (string.IsNullOrWhiteSpace(serilogConfig.Endpoint))
-    {
-        logConfiguration = logConfiguration.WriteTo.BetterStack(
-            sourceToken: serilogConfig.SourceToken
-        );
-    }
-    else
-    {
-        logConfiguration = logConfiguration.WriteTo.BetterStack(
-            sourceToken: serilogConfig.SourceToken,
-            betterStackEndpoint: serilogConfig.Endpoint
-        );
-    }
-}
+var extras = new LoggingExtras() { IsProd = envConfig.IsProd, Hostname = envConfig.Hostname, MachineName = envConfig.MachineName };
+
+builder.AddCommonLogging(serilogConfig, extras);
 
-builder.Services.AddHttpContextAccessor();
 
 var securityconfig = builder.Configuration.GetSection("Security").Get<SimpleSecurityOptions>();
 builder.AddSimpleSecurityFilter(securityconfig, msg => Log.Warning(msg));
@@ -116,12 +83,6 @@
 
 builder.Services.AddSingleton(KVPSButter.KVPSLoader.CreateIKVPS(envConfig.Storage));
 
-Log.Logger = logConfiguration
-    .Enrich.WithProperty("Hostname", envConfig.Hostname ?? Environment.MachineName)
-    .Enrich.WithProperty("MachineName", envConfig.MachineName)
-    .Enrich.WithProperty("IsProd", envConfig.IsProd)
-    .CreateLogger();
-
 var preconfiguredTokenConfig = await PreconfiguredTokens.LoadFromStorage(builder.Configuration.GetSection("PreconfiguredTokens").Get<TokenRuleOverrideConfig>());
 
 builder.Services
@@ -156,17 +117,7 @@
 
 
 var app = builder.Build();
-app.UseSerilogRequestLogging(options =>
-{
-    options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
-    {
-        var proto = httpContext.Request.Headers["X-Forwarded-Proto"].FirstOrDefault() ?? httpContext.Request.Scheme;
-        diagnosticContext.Set("RequestHost", httpContext.Request.Host.Value);
-        diagnosticContext.Set("HttpRequestType", httpContext.Request.Method);
-        diagnosticContext.Set("HttpRequestUrl", $"{proto}://{httpContext.Request.Host}{httpContext.Request.Path}{httpContext.Request.QueryString}");
-        diagnosticContext.Set("HttpRequestId", httpContext.TraceIdentifier);
-    };
-});
+app.UseCommonLogging();
 
 app.UseSimpleSecurityFilter(securityconfig);
 

README.md

@@ -47,6 +47,8 @@ The following environment variables are optional, and should be considered for a
 | SECURITY\_\_MAXREQUESTSPERSECONDPERIP | The maximum number of request from a single IP per second before throttling it |
 | SECURITY\_\_FILTERPATTERNS            | Boolean toggling filtering of scanning patterns                                |
 | SECURITY\_\_RATELIMITENABLED          | Boolean toggling if IP rate limiting is enabled                                |
+| SERILOG\_\_SOURCETOKEN                | The token used to log data from serilog                                        |
+| SERILOG\_\_ENDPOINT                   | The serilog endpoint to send logs to                                           |
 
 ## Setting Up Local Development Environment