Merge pull request #72 from serilog/dev

7.0.0 Release
serilog · May 11, 2023 · c26df53 · c26df53
2 parents b8f2e70 + 52f29a6
commit c26df53
Show file tree

Hide file tree

Showing 12 changed files with 343 additions and 175 deletions.
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@ Serilog logging for _Microsoft.Extensions.Hosting_. This package routes framewor
 **First**, install the _Serilog.Extensions.Hosting_ [NuGet package](https://www.nuget.org/packages/Serilog.Extensions.Hosting) into your app. You will need a way to view the log messages - _Serilog.Sinks.Console_ writes these to the console; there are [many more sinks available](https://www.nuget.org/packages?q=Tags%3A%22serilog%22) on NuGet.
 
 ```powershell
-Install-Package Serilog.Extensions.Hosting -DependencyVersion Highest
-Install-Package Serilog.Sinks.Console
+dotnet add package Serilog.Extensions.Hosting
+dotnet add package Serilog.Sinks.Console
 ```
 
 **Next**, in your application's _Program.cs_ file, configure Serilog first.  A `try`/`catch` block will ensure any configuration issues are appropriately logged:
@@ -88,3 +88,7 @@ You can alternatively configure Serilog using a delegate as shown below:
 This has the advantage of making the `hostingContext`'s `Configuration` object available for configuration of the logger, but at the expense of ignoring `Exception`s raised earlier in program startup.
 
 If this method is used, `Log.Logger` is assigned implicitly, and closed when the app is shut down.
+
+### Versioning
+
+This package tracks the versioning and target framework support of its [_Microsoft.Extensions.Hosting_](https://nuget.org/packages/Microsoft.Extensions.Hosting) dependency.
diff --git a/appveyor.yml b/appveyor.yml
@@ -13,7 +13,7 @@ deploy:
 - provider: NuGet
   skip_symbols: true
   api_key:
-    secure: Q65rY+zaFWOhs8a9IVSaX4Go5HNcIlEXjEFWMB83Y325WE9aXzi0xzDDc0/fJDzk
+    secure: EN9f+XXE3fW+ebL4wxrIbafdtbNvRfddBN8UUixvctYh4qMBHzr1JdnM83QsM1zo
   on:
     branch: /^(main|dev)$/
 - provider: GitHub

diff --git a/global.json b/global.json
@@ -1,7 +1,7 @@
 {
   "sdk": {
     "allowPrerelease": false,
-    "version": "6.0.300",
+    "version": "7.0.100",
     "rollForward": "latestFeature"
   }
 }
diff --git a/samples/SimpleServiceSample/SimpleServiceSample.csproj b/samples/SimpleServiceSample/SimpleServiceSample.csproj
@@ -1,16 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk.Worker">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\..\src\Serilog.Extensions.Hosting\Serilog.Extensions.Hosting.csproj" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="3.1.4" />
-    <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
+    <PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
     <PackageReference Include="Serilog.Settings.Configuration" Version="3.1.0" />
   </ItemGroup>
 

diff --git a/samples/WebApplicationSample/WebApplicationSample.csproj b/samples/WebApplicationSample/WebApplicationSample.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
     <PropertyGroup>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>net7.0</TargetFramework>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/src/Serilog.Extensions.Hosting/Properties/AssemblyInfo.cs b/src/Serilog.Extensions.Hosting/Properties/AssemblyInfo.cs
@@ -1,7 +1,7 @@
 using System.Reflection;
 using System.Runtime.CompilerServices;
 
-[assembly: AssemblyVersion("2.0.0.0")]
+[assembly: AssemblyVersion("7.0.0.0")]
 
 [assembly: InternalsVisibleTo("Serilog.Extensions.Hosting.Tests, PublicKey=" +
                               "0024000004800000940000000602000000240000525341310004000001000100fb8d13fd344a1c" +

diff --git a/src/Serilog.Extensions.Hosting/Serilog.Extensions.Hosting.csproj b/src/Serilog.Extensions.Hosting/Serilog.Extensions.Hosting.csproj
@@ -2,17 +2,18 @@
 
   <PropertyGroup>
     <Description>Serilog support for .NET Core logging in hosted services</Description>
-    <VersionPrefix>5.0.1</VersionPrefix>
+    <!-- This must match the major and minor components of the referenced Microsoft.Extensions.Logging package. -->
+    <VersionPrefix>7.0.0</VersionPrefix>
     <Authors>Microsoft;Serilog Contributors</Authors>
-    <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
+    <!-- These must match the Dependencies tab in https://www.nuget.org/packages/microsoft.extensions.hosting at
+         the target version. -->
+    <TargetFrameworks>net462;netstandard2.0;netstandard2.1;net6.0;net7.0</TargetFrameworks>
     <LangVersion>8</LangVersion>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <AssemblyName>Serilog.Extensions.Hosting</AssemblyName>
     <AssemblyOriginatorKeyFile>../../assets/Serilog.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
-    <PackageId>Serilog.Extensions.Hosting</PackageId>
     <PackageTags>serilog;aspnet;aspnetcore;hosting</PackageTags>
     <PackageIcon>icon.png</PackageIcon>
     <PackageProjectUrl>https://github.com/serilog/serilog-extensions-hosting</PackageProjectUrl>
@@ -23,20 +24,21 @@
     <RootNamespace>Serilog</RootNamespace>
   </PropertyGroup>
 
-  <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net462' or '$(TargetFramework)' == 'netstandard2.0' ">
     <DefineConstants>$(DefineConstants);NO_RELOADABLE_LOGGER</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Serilog" Version="2.10.0" />
-    <PackageReference Include="Serilog.Extensions.Logging" Version="3.1.0" />
-    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="3.1.8" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.1.8" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.1.8" />
+    <None Include="..\..\assets\icon.png" Pack="true" Visible="false" PackagePath="" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+    <PackageReference Include="Serilog" Version="2.12.0" />
   </ItemGroup>
 
   <ItemGroup>
-    <None Include="..\..\assets\icon.png" Pack="true" Visible="false" PackagePath="" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
+    <!-- The versions of all references in this group must match the major and minor components of the package version prefix. -->
+    <PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
   </ItemGroup>
 </Project>
diff --git a/src/Serilog.Extensions.Hosting/SerilogHostBuilderExtensions.cs b/src/Serilog.Extensions.Hosting/SerilogHostBuilderExtensions.cs
@@ -13,10 +13,8 @@
 // limitations under the License.
 
 using System;
-using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Serilog.Extensions.Hosting;
 using Serilog.Extensions.Logging;
 // ReSharper disable MemberCanBePrivate.Global
 
@@ -27,20 +25,6 @@ namespace Serilog
     /// </summary>
     public static class SerilogHostBuilderExtensions
     {
-        // Used internally to pass information through the container. We need to do this because if `logger` is the
-        // root logger, registering it as a singleton may lead to disposal along with the container by MEDI. This isn't
-        // always desirable, i.e. we may be handed a logger and `dispose: false`, so wrapping it keeps us in control
-        // of when the logger is disposed.
-        class RegisteredLogger
-        {
-            public RegisteredLogger(ILogger logger)
-            {
-                Logger = logger;
-            }
-
-            public ILogger Logger { get; }
-        }
-
         /// <summary>
         /// Sets Serilog as the logging provider.
         /// </summary>
@@ -63,33 +47,7 @@ public RegisteredLogger(ILogger logger)
 
             builder.ConfigureServices((_, collection) =>
             {
-                if (providers != null)
-                {
-                    collection.AddSingleton<ILoggerFactory>(services =>
-                    {
-                        var factory = new SerilogLoggerFactory(logger, dispose, providers);
-
-                        foreach (var provider in services.GetServices<ILoggerProvider>())
-                            factory.AddProvider(provider);
-
-                        return factory;
-                    });
-                }
-                else
-                {
-                    collection.AddSingleton<ILoggerFactory>(services => new SerilogLoggerFactory(logger, dispose));
-                }
-
-                if (logger != null)
-                {
-                    // This won't (and shouldn't) take ownership of the logger. 
-                    collection.AddSingleton(logger);
-
-                    // Still need to use RegisteredLogger as it is used by ConfigureDiagnosticContext.
-                    collection.AddSingleton(new RegisteredLogger(logger));
-                }
-                bool useRegisteredLogger = logger != null;
-                ConfigureDiagnosticContext(collection, useRegisteredLogger);
+                collection.AddSerilog(logger, dispose, providers);
             });
 
             return builder;
@@ -148,108 +106,16 @@ public RegisteredLogger(ILogger logger)
             if (builder == null) throw new ArgumentNullException(nameof(builder));
             if (configureLogger == null) throw new ArgumentNullException(nameof(configureLogger));
 
-            // This check is eager; replacing the bootstrap logger after calling this method is not supported.
-#if !NO_RELOADABLE_LOGGER
-            var reloadable = Log.Logger as ReloadableLogger;
-            var useReload = reloadable != null && !preserveStaticLogger;
-#else
-            const bool useReload = false;
-#endif
-
             builder.ConfigureServices((context, collection) =>
             {
-                LoggerProviderCollection loggerProviders = null;
-                if (writeToProviders)
-                {
-                    loggerProviders = new LoggerProviderCollection();
-                }
-                
-                collection.AddSingleton(services =>
-                {
-                    ILogger logger;
-#if !NO_RELOADABLE_LOGGER
-                    if (useReload)
-                    {
-                        reloadable!.Reload(cfg =>
-                        {
-                            if (loggerProviders != null)
-                                cfg.WriteTo.Providers(loggerProviders);
-                            
-                            configureLogger(context, services, cfg);
-                            return cfg;
-                        });
-                        
-                        logger = reloadable.Freeze();
-                    }
-                    else
-#endif
-                    {
-                        var loggerConfiguration = new LoggerConfiguration();
-
-                        if (loggerProviders != null)
-                            loggerConfiguration.WriteTo.Providers(loggerProviders);
-
-                        configureLogger(context, services, loggerConfiguration);
-                        logger = loggerConfiguration.CreateLogger();
-                    }
-
-                    return new RegisteredLogger(logger);
-                });
-
-                collection.AddSingleton(services =>
-                {
-                    // How can we register the logger, here, but not have MEDI dispose it?
-                    // Using the `NullEnricher` hack to prevent disposal.
-                    var logger = services.GetRequiredService<RegisteredLogger>().Logger;
-                    return logger.ForContext(new NullEnricher());
-                });
-                
-                collection.AddSingleton<ILoggerFactory>(services =>
-                {
-                    var logger = services.GetRequiredService<RegisteredLogger>().Logger;
-                    
-                    ILogger registeredLogger = null;
-                    if (preserveStaticLogger)
-                    {
-                        registeredLogger = logger;
-                    }
-                    else
-                    {
-                        // Passing a `null` logger to `SerilogLoggerFactory` results in disposal via
-                        // `Log.CloseAndFlush()`, which additionally replaces the static logger with a no-op.
-                        Log.Logger = logger;
-                    }
-
-                    var factory = new SerilogLoggerFactory(registeredLogger, !useReload, loggerProviders);
-
-                    if (writeToProviders)
-                    {
-                        foreach (var provider in services.GetServices<ILoggerProvider>())
-                            factory.AddProvider(provider);
-                    }
-
-                    return factory;
-                });
-
-                ConfigureDiagnosticContext(collection, preserveStaticLogger);
+                collection.AddSerilog(
+                    (services, loggerConfiguration) =>
+                        configureLogger(context, services, loggerConfiguration),
+                    preserveStaticLogger: preserveStaticLogger,
+                    writeToProviders: writeToProviders);
             });
 
             return builder;
         }
-
-        static void ConfigureDiagnosticContext(IServiceCollection collection, bool useRegisteredLogger)
-        {
-            if (collection == null) throw new ArgumentNullException(nameof(collection));
-
-            // Registered to provide two services...            
-            // Consumed by e.g. middleware
-            collection.AddSingleton(services =>
-            {
-                ILogger logger = useRegisteredLogger ? services.GetRequiredService<RegisteredLogger>().Logger : null;
-                return new DiagnosticContext(logger);
-            });
-            // Consumed by user code
-            collection.AddSingleton<IDiagnosticContext>(services => services.GetRequiredService<DiagnosticContext>());
-        }
     }
 }