Skip to content

use structured logging #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StuartFerguson merged 1 commit into from
Oct 26, 2026
Merged

use structured logging #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,52 +3,52 @@
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="HealthMonitoring.Client" Version="2026.10.1" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.13" />
<PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.13" />
<PackageVersion Include="Microsoft.EntityFrameworkCore" Version="10.0.13" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.13" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Relational" Version="10.0.13" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Tools" Version="10.0.13" />
<PackageVersion Include="HealthMonitoring.Client" Version="2026.10.2.55" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Relational" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Tools" Version="10.0.14" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.11.0" />
<PackageVersion Include="Imposter" Version="1.0.3" />
<PackageVersion Include="Imposter" Version="1.0.7" />
<PackageVersion Include="SharpCompress" Version="0.50.7" />
<PackageVersion Include="Shouldly" Version="4.3.0" />
<PackageVersion Include="SSH.NET" Version="2026.0.0" />
<PackageVersion Include="System.Security.Cryptography.Pkcs" Version="10.0.13" />
<PackageVersion Include="TransactionProcessing.ApiDefaults" Version="2026.10.4" />
<PackageVersion Include="TransactionProcessor.Database" Version="2026.10.1" />
<PackageVersion Include="System.Security.Cryptography.Pkcs" Version="10.0.14" />
<PackageVersion Include="TransactionProcessing.ApiDefaults" Version="2026.11.2" />
<PackageVersion Include="TransactionProcessor.Database" Version="2026.10.2.411" />
<PackageVersion Include="xunit.v3" Version="4.0.2" />
<PackageVersion Include="xunit.runner.visualstudio" Version="4.0.1" />
<PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.12.0" />
<PackageVersion Include="ClientProxyBase" Version="2026.10.4" />
<PackageVersion Include="Shared.Results" Version="2026.10.4" />
<PackageVersion Include="ClientProxyBase" Version="2026.11.2" />
<PackageVersion Include="Shared.Results" Version="2026.11.2" />
<PackageVersion Include="MediatR" Version="14.2.0" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.DynamicLinq" Version="10.7.4" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.13" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.14" />
<PackageVersion Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.23.0" />
<PackageVersion Include="Shared.Results.Web" Version="2026.10.4" />
<PackageVersion Include="Shared.Results.Web" Version="2026.11.2" />
<PackageVersion Include="OpenIddict.Validation.AspNetCore" Version="7.7.2" />
<PackageVersion Include="OpenIddict.Validation.SystemNetHttp" Version="7.7.2" />
<PackageVersion Include="Lamar" Version="16.0.0" />
<PackageVersion Include="Lamar.Microsoft.DependencyInjection" Version="16.0.0" />
<PackageVersion Include="NLog.Extensions.Logging" Version="6.2.2" />
<PackageVersion Include="Shared" Version="2026.10.4" />
<PackageVersion Include="Shared" Version="2026.11.2" />
<PackageVersion Include="AspNetCore.HealthChecks.SqlServer" Version="9.0.0" />
<PackageVersion Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0" />
<PackageVersion Include="AspNetCore.HealthChecks.UI.InMemory.Storage" Version="9.0.0" />
<PackageVersion Include="AspNetCore.HealthChecks.Uris" Version="9.0.0" />
<PackageVersion Include="Microsoft.Extensions.Hosting.WindowsServices" Version="10.0.13" />
<PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.13" />
<PackageVersion Include="Microsoft.Extensions.Hosting.WindowsServices" Version="10.0.14" />
<PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="10.0.14" />
<PackageVersion Include="Sentry.AspNetCore" Version="6.12.1" />
<PackageVersion Include="Shared.Logger" Version="2026.10.4" />
<PackageVersion Include="Shared.IntegrationTesting" Version="2026.10.4" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="10.0.13" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.InMemory" Version="10.0.13" />
<PackageVersion Include="Shared.Logger" Version="2026.11.2" />
<PackageVersion Include="Shared.IntegrationTesting" Version="2026.11.2" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.Design" Version="10.0.14" />
<PackageVersion Include="Microsoft.EntityFrameworkCore.InMemory" Version="10.0.14" />
<PackageVersion Include="coverlet.collector" Version="3.2.0" />
<PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.13" />
<PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.14" />
<PackageVersion Include="Ductus.FluentDocker" Version="2.85.0" />
<PackageVersion Include="NLog" Version="6.2.2" />
<PackageVersion Include="SecurityService.Client" Version="2026.10.2.200" />
<PackageVersion Include="SecurityService.Client" Version="2026.10.3.204" />
</ItemGroup>
</Project>
4 changes: 2 additions & 2 deletions EstateReportingAPI.IntegrationTests/CustomWebApplicationFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ public TestAuthHandler(
IOptionsMonitor<TestAuthHandlerOptions> options,
ILoggerFactory logger,
UrlEncoder encoder,
ISystemClock clock) : base(options, logger, encoder, clock)
{
TimeProvider clock) : base(options, logger, encoder) {
_defaultUserId = options.CurrentValue.DefaultUserId;
_defaultEstateId = options.CurrentValue.DefaultEstateId;
}
Expand Down
8 changes: 4 additions & 4 deletions EstateReportingAPI.IntegrationTests/DatabaseHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,12 +926,12 @@ public async Task CreateStoredProcedures(CancellationToken cancellationToken)
}
directiories = directiories.OrderBy(d => d).ToArray();

foreach (String directiory in directiories)
foreach (String directory in directiories)
{
String[] sqlFiles = Directory.GetFiles(directiory, "*.sql");
String[] sqlFiles = Directory.GetFiles(directory, "*.sql");
foreach (String sqlFile in sqlFiles.OrderBy(x => x))
{
Logger.LogDebug($"About to create Stored Procedure [{sqlFile}]");
Logger.LogDebug("About to create Stored Procedure [{sqlFile}]", sqlFile);
String sql = System.IO.File.ReadAllText(sqlFile);

// Check here is we need to replace a Database Name
Expand All @@ -943,7 +943,7 @@ public async Task CreateStoredProcedures(CancellationToken cancellationToken)
// Create the new view using the original sql from file
await this.Context.Database.ExecuteSqlRawAsync(sql, cancellationToken);

Logger.LogDebug($"Created Stored Procedure [{sqlFile}] successfully.");
Logger.LogDebug("Created Stored Procedure [{sqlFile}] successfully.", sqlFile);
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion EstateReportingAPI.IntegrationTests/IntegrationTestEnvironment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ public static async Task<IntegrationTestEnvironment> GetAsync()

NlogLogger logger = new();
logger.Initialise(LogManager.GetLogger(ScenarioName), ScenarioName);
LogManager.AddHiddenAssembly(typeof(NlogLogger).Assembly);
LogManager.Setup().SetupLogFactory(setup =>
setup.AddCallSiteHiddenAssembly(typeof(NlogLogger).Assembly));

TestDockerHelper dockerHelper = new();
dockerHelper.Logger = logger;
Expand Down
21 changes: 0 additions & 21 deletions EstateReportingAPI/Bootstrapper/SharedLibraryCompatibility.cs
View file
Open in desktop

This file was deleted.

28 changes: 15 additions & 13 deletions EstateReportingAPI/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,24 @@ private static void ConfigureHost(WebApplicationBuilder builder)
["HealthMonitoring:Service:Version"] = Assembly.GetEntryAssembly()?.GetName().Version?.ToString() ?? "0.0.0.0"
});

IConfiguration configuration = builder.Configuration;
SharedLibraryCompatibility.InitializeConfiguration((IConfigurationRoot)builder.Configuration);
if (configuration.GetSection("SentryConfiguration").Exists() && !builder.Environment.IsDevelopment())
Shared.General.ConfigurationReader.Initialise(builder.Configuration);
if (builder.Configuration.GetSection("SentryConfiguration").Exists() && !builder.Environment.IsDevelopment())
{
builder.WebHost.UseSentry(options =>
{
options.Dsn = configuration["SentryConfiguration:Dsn"];
options.Dsn = builder.Configuration["SentryConfiguration:Dsn"];
options.SendDefaultPii = true;
options.MaxRequestBodySize = RequestSize.Always;
options.CaptureBlockingCalls = configuration.GetValue("SentryConfiguration:CaptureBlockingCalls", false);
options.IncludeActivityData = configuration.GetValue("SentryConfiguration:IncludeActivityData", false);
options.CaptureBlockingCalls = builder.Configuration.GetValue("SentryConfiguration:CaptureBlockingCalls", false);
options.IncludeActivityData = builder.Configuration.GetValue("SentryConfiguration:IncludeActivityData", false);
options.Release = Assembly.GetExecutingAssembly().GetName().Version?.ToString() ?? "unknown";
});
}
builder.Host.UseLamar((context, services) =>
{
services.IncludeRegistry(new MiddlewareRegistry(configuration, context.HostingEnvironment));
services.IncludeRegistry(new RepositoryRegistry(configuration, context.HostingEnvironment));
services.IncludeRegistry(new MediatorRegistry(configuration));
services.IncludeRegistry(new MiddlewareRegistry(builder.Configuration, context.HostingEnvironment));
services.IncludeRegistry(new RepositoryRegistry(builder.Configuration, context.HostingEnvironment));
services.IncludeRegistry(new MediatorRegistry(builder.Configuration));
services.IncludeRegistry(new SerialiserRegistry());
});
}
Expand All @@ -103,10 +102,13 @@ private static void ConfigurePipeline(WebApplication app)
{
app.UseDeveloperExceptionPage();
}

ILogger logger = app.Services.GetRequiredService<ILoggerFactory>().CreateLogger("EstateManagement");
SharedLibraryCompatibility.InitializeLogging(logger);
((IConfigurationRoot)app.Configuration).LogConfiguration(message => logger.LogWarning("{ConfigurationMessage}", message));

LogManager.Setup().LoadConfigurationFromFile("NLog.config");
NLog.Logger logger = LogManager.GetLogger("EstateReporting");
Shared.Logger.Logger.Initialise(logger, "EstateReporting");

IConfigurationRoot appConfiguration = (IConfigurationRoot)app.Configuration;
appConfiguration.LogConfiguration(Shared.Logger.Logger.LogWarning);

app.UseMiddleware<TenantMiddleware>();
app.AddRequestResponseLogging();
Expand Down
36 changes: 14 additions & 22 deletions EstateReportingAPI/nlog.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
<targets>
<target name="asyncFile" xsi:type="AsyncWrapper">
<target name="logfile" xsi:type="File"
fileName="/home/txnproc/trace/estatereporting.log"
layout="${date:format=dd/MM/yyyy HH\:mm\:ss.ffff} | ${level} | ${mdlc:CorrelationId:fallback=NO-ID}| ${callsite:className=true} | ${message} | ${exception:format=type,method:maxInnerExceptionLevel=5:innerFormat=shortType,message,method:InnerExceptionSeparator= | }"
archiveFileName="/home/txnproc/trace/estatereporting.{#####}.log"
fileName="/home/txnproc/trace/estatereporting.json"
archiveFileName="/home/txnproc/trace/estatereporting.{#####}.json"
archiveAboveSize="104857600"
archiveNumbering="Sequence"
concurrentWrites="true"
maxArchiveFiles="2"/>
<target name="healthlogfile" xsi:type="File"
fileName="/home/txnproc/trace/estatereporting_health.log"
layout="${date:format=dd/MM/yyyy HH\:mm\:ss.ffff} | ${level} | ${callsite:className=true} | ${message} | ${exception:format=type,method:maxInnerExceptionLevel=5:innerFormat=shortType,message,method:InnerExceptionSeparator= | }"
archiveFileName="/home/txnproc/trace/estatereporting_health.{#####}.log"
archiveAboveSize="104857600"
archiveNumbering="Sequence"
concurrentWrites="true"
maxArchiveFiles="2"/>
maxArchiveFiles="2">
<layout xsi:type="JsonLayout"
includeEventProperties="true"
excludeProperties="timestampUtc">
<attribute name="timestampUtc" layout="${date:universalTime=true:format=o}" />
<attribute name="level" layout="${level:uppercase=true}" />
<attribute name="message" layout="${message}" />
<attribute name="exception" layout="${exception:format=type,method:maxInnerExceptionLevel=5:innerFormat=shortType,message,method:InnerExceptionSeparator= | }" />
</layout>
</target>
</target>
</targets>

Expand All @@ -32,15 +32,7 @@

<rules>
<logger name="Microsoft.*" minlevel="Warn" writeTo="" final="true" />
<logger name="*" minlevel="Warn" writeTo="logfile">
<filters defaultAction="Log">
<when condition="contains('${message}', 'HEALTH_CHECK')" action="Ignore"></when>
</filters>
</logger>
<logger name="*" minlevel="Warn" writeTo="healthlogfile">
<filters defaultAction="Ignore">
<when condition="contains('${message}', 'HEALTH_CHECK')" action="Log"></when>
</filters>
</logger>
<logger name="*" minlevel="Warn" writeTo="logfile">
</logger>
</rules>
</nlog>
Loading