Logger config tests need work but basic coverage is in place

Author: jbarden

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.csproj

@@ -1,6 +1,7 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
+    <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
@@ -17,6 +18,7 @@
 
   <PropertyGroup>
 	<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+	<IsPackable>true</IsPackable>
 	<Title>AStar.Dev.Logging.Extensions</Title>
 	<Company>AStar Development</Company>
 	<Copyright>AStar Development, 2024</Copyright>
@@ -25,9 +27,9 @@
 	<IncludeSymbols>True</IncludeSymbols>
 	<SymbolPackageFormat>snupkg</SymbolPackageFormat>
 	<GenerateDocumentationFile>True</GenerateDocumentationFile>
-	<RepositoryUrl>https://github.com/jbarden/astar-dev-logging-extensions.git</RepositoryUrl>
+	<RepositoryUrl>https://github.com/astar-development/astar-dev-logging-extensions.git</RepositoryUrl>
 	<RepositoryType>git</RepositoryType>
-	<PackageProjectUrl>https://github.com/jbarden/astar-dev-logging-extensions</PackageProjectUrl>
+	<PackageProjectUrl>https://github.com/astar-development/astar-dev-logging-extensions</PackageProjectUrl>
 	<Description>A collection of logging utilities.</Description>
 	<Version>0.4.0</Version>
 	<Authors>AStar Development, Jason Barden</Authors>
@@ -37,6 +39,18 @@
 	<PackageReleaseNotes>version 0.4.0, no changes - version increased as part of the migration to the new AStar NuGet / GitHub organisations.</PackageReleaseNotes>
   </PropertyGroup>
 
+  <ItemGroup>
+		<PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.22.0" />
+		<PackageReference Include="AStar.Dev.Utilities" Version="1.5.1" />
+		<PackageReference Include="Serilog.AspNetCore" Version="8.0.3" />
+		<PackageReference Include="Serilog.Enrichers.Span" Version="3.1.0" />
+		<PackageReference Include="Serilog.Enrichers.Environment" Version="3.0.1" />
+		<PackageReference Include="Serilog.Expressions" Version="5.0.0" />
+		<PackageReference Include="Serilog.Sinks.Seq" Version="8.0.0" />
+		<PackageReference Include="Serilog.Exceptions" Version="8.4.0" />
+		<PackageReference Include="Serilog.Sinks.ApplicationInsights" Version="4.0.0" />
+  </ItemGroup>
+
   <ItemGroup>
 	<None Include="..\..\AStar.png">
 	  <Pack>True</Pack>

src/AStar.Dev.Logging.Extensions/AStar.Dev.Logging.Extensions.xml

@@ -0,0 +1,54 @@
+using AStar.Dev.Logging.Extensions.Models;
+using AStar.Dev.Utilities;
+using Microsoft.ApplicationInsights.Extensibility;
+using Serilog;
+
+namespace AStar.Dev.Logging.Extensions;
+
+/// <summary>
+/// The <see cref="LoggingExtensions" /> class contains, as you might expect, extension methods for configuring Serilog / Application Insights.
+/// </summary>
+public static class LoggingExtensions
+{
+    /// <summary>
+    /// The <see cref="AddSerilogLogging" /> method will add Serilog to the logging providers.
+    /// </summary>
+    /// <param name="builder">
+    /// </param>
+    /// <param name="externalSettingsFile">
+    /// The name (including extension) of the file containing the Serilog Configuration settings.
+    /// </param>
+    /// <returns>
+    /// The original instance of <see cref="WebApplicationBuilder" /> for further method chaining.
+    /// </returns>
+    public static WebApplicationBuilder AddSerilogLogging(this WebApplicationBuilder builder, string externalSettingsFile = "")
+    {
+        if(externalSettingsFile.IsNotNullOrWhiteSpace())
+        {
+            _ = builder.Configuration.AddJsonFile(path: externalSettingsFile, optional: false, reloadOnChange: true);
+        }
+
+        _ = builder.Configuration.AddUserSecrets<Program>();
+
+        _ = builder.Services.AddApplicationInsightsTelemetry();
+        var serviceProvider = builder.Services.BuildServiceProvider();
+        var seqServerUrl = builder.Configuration.Get<SerilogConfig>()!.Serilog.WriteTo[0].Args.ServerUrl;
+        var logger = new LoggerConfiguration()
+            .WriteTo.ApplicationInsights(serviceProvider.GetRequiredService<TelemetryConfiguration>(), TelemetryConverter.Traces)
+            .WriteTo.Console()
+            .WriteTo.Seq(seqServerUrl)
+            .CreateLogger();
+
+        logger.Debug("Serilog has been configured.");
+
+        Log.Logger = logger;
+
+        _ = builder.Host
+                    .UseSerilog((context, loggerConfig) => loggerConfig
+                    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level}] {Message:lj}{NewLine}{Exception}")
+                    .ReadFrom.Configuration(context.Configuration)
+                    .Enrich.FromLogContext());
+
+        return builder;
+    }
+}

src/AStar.Dev.Logging.Extensions/LoggingExtensions.cs

@@ -0,0 +1,12 @@
+namespace AStar.Dev.Logging.Extensions.Models;
+
+/// <summary>
+/// The <see cref="ApplicationInsights"/> class which is used to configure the logging.
+/// </summary>
+public class ApplicationInsights
+{
+    /// <summary>
+    /// The Log level to use.
+    /// </summary>
+    public LogLevel LogLevel { get; set; } = new();
+}

src/AStar.Dev.Logging.Extensions/Models/ApplicationInsights.cs

@@ -0,0 +1,12 @@
+namespace AStar.Dev.Logging.Extensions.Models;
+
+/// <summary>
+/// The <see cref="Args"/> class used by Serilog WriteTo section of the logging configuration.
+/// </summary>
+public class Args
+{
+    /// <summary>
+    /// The Serilog server Url.
+    /// </summary>
+    public string ServerUrl { get; set; } = string.Empty;
+}

src/AStar.Dev.Logging.Extensions/Models/Args.cs

@@ -0,0 +1,17 @@
+namespace AStar.Dev.Logging.Extensions.Models;
+
+/// <summary>
+/// The <see cref="Console"/> class used by Serilog Console section of the logging configuration.
+/// </summary>
+public class Console
+{
+    /// <summary>
+    /// The Formatter Name to use.
+    /// </summary>
+    public string FormatterName { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The <see cref="FormatterOptions"/> class used to supply the Formatter Options to use.
+    /// </summary>
+    public FormatterOptions FormatterOptions { get; set; } = new();
+}