Serilog 4 updates; unpublish enricher types accessible via extensions

Author: nblumhardt

.idea/.idea.serilog-enrichers-environment/.idea/.gitignore

@@ -46,15 +46,4 @@ foreach ($test in gci test/*.Tests) {
     Pop-Location
 }
 
-foreach ($test in ls test/*.PerformanceTests) {
-    Push-Location $test
-
-	echo "build: Building performance test project in $test"
-
-    & dotnet build -c Release
-    if($LASTEXITCODE -ne 0) { exit 2 }
-
-    Pop-Location
-}
-
 Pop-Location

.idea/.idea.serilog-enrichers-environment/.idea/encodings.xml

@@ -1,13 +1,13 @@
 # Serilog.Enrichers.Environment
 
-Enriches Serilog events with information from the process environment.
+Enriches Serilog events with information from the execution environment.
 
 [![Build status](https://ci.appveyor.com/api/projects/status/yfbvbdxd5vwh6955?svg=true)](https://ci.appveyor.com/project/serilog/serilog-enrichers-environment) [![NuGet Version](http://img.shields.io/nuget/v/Serilog.Enrichers.Environment.svg?style=flat)](https://www.nuget.org/packages/Serilog.Enrichers.Environment/)
 
 To use the enricher, first install the NuGet package:
 
 ```powershell
-Install-Package Serilog.Enrichers.Environment
+dotnet add package Serilog.Enrichers.Environment
 ```
 
 Then, apply the enricher to you `LoggerConfiguration`:
@@ -28,6 +28,6 @@ The package includes:
  * `WithMachineName()` - adds `MachineName` based on either `%COMPUTERNAME%` (Windows) or `$HOSTNAME` (macOS, Linux)
  * `WithEnvironmentUserName()` - adds `EnvironmentUserName` based on `USERNAME` and `USERDOMAIN` (if available)
  * `WithEnvironmentName()` - adds `EnvironmentName` based on `ASPNETCORE_ENVIRONMENT` or `DOTNET_ENVIRONMENT` (when both are available then 'ASPNETCORE_ENVIRONMENT' takes precedence, when none are available then the fallback value will be 'Production')
- * `WithEnvironmentVariable(string envVarName, string propertyName = null)` - adds an `<envVarName>` property to the log event with the value for the specified enviroment variable. Optional `<propertyName>` will override `<envVarName>` as propertyName.
+ * `WithEnvironmentVariable(string envVarName, string propertyName = null)` - adds an `<envVarName>` property to the log event with the value for the specified environment variable. Optional `<propertyName>` will override `<envVarName>` as propertyName.
 
 Copyright &copy; 2016 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html).

.idea/.idea.serilog-enrichers-environment/.idea/indexLayout.xml

@@ -1,26 +1,23 @@
 version: '{build}'
 skip_tags: true
 image: Visual Studio 2022
-configuration: Release
-install:
-  - ps: mkdir -Force ".\build\" | Out-Null
-  
 build_script:
-- ps: ./Build.ps1
+    - pwsh: ./Build.ps1
 test: off
 artifacts:
-- path: artifacts/Serilog.*.nupkg
+    - path: artifacts/Serilog.*.nupkg
 deploy:
-- provider: NuGet
-  api_key:
-    secure: Fh92tRIFbe1FAiyD8lTThWgAorQ1vV+eFYMlUK0iLHBBenJcy/UYc1qj6kgHvUcO
-  skip_symbols: true
-  on:
-    branch: /^(main|dev)$/
-- provider: GitHub
-  auth_token:
-    secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
-  artifact: /Serilog.*\.nupkg/
-  tag: v$(appveyor_build_version)
-  on:
-    branch: main
+    - provider: NuGet
+      api_key:
+          secure: Fh92tRIFbe1FAiyD8lTThWgAorQ1vV+eFYMlUK0iLHBBenJcy/UYc1qj6kgHvUcO
+      skip_symbols: true
+      on:
+          branch: /^(main|dev)$/
+    - provider: GitHub
+      auth_token:
+          secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX
+      artifact: /Serilog.*\.nupkg/
+      tag: v$(appveyor_build_version)
+      on:
+          branch: main
+          

.idea/.idea.serilog-enrichers-environment/.idea/vcs.xml

@@ -8,9 +8,9 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{E9D1B5E1-DEB9-4A04-8BAB-24EC7240ADAF}"
 	ProjectSection(SolutionItems) = preProject
 		Build.ps1 = Build.ps1
-		NuGet.Config = NuGet.Config
 		README.md = README.md
 		assets\Serilog.snk = assets\Serilog.snk
+		appveyor.yml = appveyor.yml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{406006F7-12FA-4A8A-ADC8-80E5338F5275}"

Build.ps1

@@ -15,31 +15,28 @@
 using Serilog.Core;
 using Serilog.Events;
 
-namespace Serilog.Enrichers
-{
-    public abstract class CachedPropertyEnricher: ILogEventEnricher
-    {
-        private LogEventProperty? _cachedProperty { get; set; }
+namespace Serilog.Enrichers;
 
-        /// <summary>
-        /// Enrich the log event.
-        /// </summary>
-        /// <param name="logEvent">The log event to enrich.</param>
-        /// <param name="propertyFactory">Factory for creating new properties to add to the event.</param>
-        public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
-        {
-            logEvent.AddPropertyIfAbsent(GetLogEventProperty(propertyFactory));
-        }
+abstract class CachedPropertyEnricher: ILogEventEnricher
+{
+    LogEventProperty? CachedProperty { get; set; }
 
-        private LogEventProperty GetLogEventProperty(ILogEventPropertyFactory propertyFactory)
-        {
-            // Don't care about thread-safety, in the worst case the field gets overwritten and one
-            // property will be GCed
-            _cachedProperty ??= CreateProperty(propertyFactory);
+    /// <summary>
+    /// Enrich the log event.
+    /// </summary>
+    /// <param name="logEvent">The log event to enrich.</param>
+    /// <param name="propertyFactory">Factory for creating new properties to add to the event.</param>
+    public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
+    {
+        logEvent.AddPropertyIfAbsent(GetLogEventProperty(propertyFactory));
+    }
 
-            return _cachedProperty;
-        }
-        
-        protected abstract LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory);
+    LogEventProperty GetLogEventProperty(ILogEventPropertyFactory propertyFactory)
+    {
+        // Don't care about thread-safety, in the worst case the field gets overwritten and one
+        // property will be GCed
+        return CachedProperty ??= CreateProperty(propertyFactory);
     }
+        
+    protected abstract LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory);
 }

README.md

@@ -15,37 +15,33 @@
 using System;
 using Serilog.Core;
 using Serilog.Events;
-using System.Runtime.CompilerServices;
 
-namespace Serilog.Enrichers
+namespace Serilog.Enrichers;
+
+/// <summary>
+/// Enriches log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+/// </summary>
+class EnvironmentNameEnricher : CachedPropertyEnricher
 {
     /// <summary>
-    /// Enriches log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+    /// The property name added to enriched log events.
     /// </summary>
-    public class EnvironmentNameEnricher : CachedPropertyEnricher
+    const string EnvironmentNamePropertyName = "EnvironmentName";
+
+    protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
     {
-        /// <summary>
-        /// The property name added to enriched log events.
-        /// </summary>
-        public const string EnvironmentNamePropertyName = "EnvironmentName";
+        var environmentName = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
 
-        // Qualify as uncommon-path
-        [MethodImpl(MethodImplOptions.NoInlining)]
-        protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
+        if (string.IsNullOrWhiteSpace(environmentName))
         {
-            var environmentName = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
-
-            if (string.IsNullOrWhiteSpace(environmentName))
-            {
-                environmentName = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
-            }
-
-            if (string.IsNullOrWhiteSpace(environmentName))
-            {
-                environmentName = "Production";
-            }
+            environmentName = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+        }
 
-            return propertyFactory.CreateProperty(EnvironmentNamePropertyName, environmentName);
+        if (string.IsNullOrWhiteSpace(environmentName))
+        {
+            environmentName = "Production";
         }
+
+        return propertyFactory.CreateProperty(EnvironmentNamePropertyName, environmentName);
     }
-}
+}

appveyor.yml

@@ -16,30 +16,24 @@
 using Serilog.Core;
 using Serilog.Events;
 
-namespace Serilog.Enrichers
+namespace Serilog.Enrichers;
+
+/// <summary>
+/// Enriches log events with an EnvironmentUserName property containing [<see cref="Environment.UserDomainName"/>\]<see cref="Environment.UserName"/>.
+/// </summary>
+class EnvironmentUserNameEnricher : CachedPropertyEnricher
 {
     /// <summary>
-    /// Enriches log events with an EnvironmentUserName property containing [<see cref="Environment.UserDomainName"/>\]<see cref="Environment.UserName"/>.
+    /// The property name added to enriched log events.
     /// </summary>
-    public class EnvironmentUserNameEnricher : CachedPropertyEnricher
-    {
-        /// <summary>
-        /// The property name added to enriched log events.
-        /// </summary>
-        public const string EnvironmentUserNamePropertyName = "EnvironmentUserName";
+    const string EnvironmentUserNamePropertyName = "EnvironmentUserName";
 
-        protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
-        {
-#if ENV_USER_NAME
-            var userDomainName = Environment.UserDomainName;
-            var userName = Environment.UserName;
-#else
-            var userDomainName = Environment.GetEnvironmentVariable("USERDOMAIN");
-            var userName = Environment.GetEnvironmentVariable("USERNAME");
-#endif
-            var environmentUserName =  !string.IsNullOrWhiteSpace(userDomainName) ? $@"{userDomainName}\{userName}" : userName;
+    protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
+    {
+        var userDomainName = Environment.UserDomainName;
+        var userName = Environment.UserName;
+        var environmentUserName =  !string.IsNullOrWhiteSpace(userDomainName) ? $@"{userDomainName}\{userName}" : userName;
 
-            return propertyFactory.CreateProperty(EnvironmentUserNamePropertyName, environmentUserName);
-        }
+        return propertyFactory.CreateProperty(EnvironmentUserNamePropertyName, environmentUserName);
     }
-}
+}

serilog-enrichers-environment.sln

@@ -15,35 +15,31 @@
 using System;
 using Serilog.Core;
 using Serilog.Events;
-using System.Runtime.CompilerServices;
 
-namespace Serilog.Enrichers
+namespace Serilog.Enrichers;
+
+/// <summary>
+/// Enriches log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+/// </summary>
+class EnvironmentVariableEnricher : CachedPropertyEnricher
 {
+    readonly string _envVarName;
+
     /// <summary>
-    /// Enriches log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+    /// The property name added to enriched log events.
     /// </summary>
-    public class EnvironmentVariableEnricher : CachedPropertyEnricher
-    {
-        private readonly string _envVarName;
-
-        /// <summary>
-        /// The property name added to enriched log events.
-        /// </summary>
-        public string EnvironmentVariablePropertyName { get; }
+    string EnvironmentVariablePropertyName { get; }
 
-        public EnvironmentVariableEnricher(string envVarName, string? propertyName)
-        {
-            _envVarName = envVarName;
-            EnvironmentVariablePropertyName = propertyName ?? envVarName;
-        }
+    public EnvironmentVariableEnricher(string envVarName, string? propertyName)
+    {
+        _envVarName = envVarName;
+        EnvironmentVariablePropertyName = propertyName ?? envVarName;
+    }
 
-        // Qualify as uncommon-path
-        [MethodImpl(MethodImplOptions.NoInlining)]
-        protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
-        {
-            var environmentVariableValue = Environment.GetEnvironmentVariable(_envVarName);
+    protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
+    {
+        var environmentVariableValue = Environment.GetEnvironmentVariable(_envVarName);
 
-            return propertyFactory.CreateProperty(EnvironmentVariablePropertyName, environmentVariableValue);
-        }
+        return propertyFactory.CreateProperty(EnvironmentVariablePropertyName, environmentVariableValue);
     }
-}
+}

src/Serilog.Enrichers.Environment/Enrichers/CachedPropertyEnricher.cs

@@ -15,34 +15,22 @@
 using System;
 using Serilog.Core;
 using Serilog.Events;
-using System.Runtime.CompilerServices;
 
-#if NETSTANDARD1_3
-using System.Net;
-#endif
+namespace Serilog.Enrichers;
 
-namespace Serilog.Enrichers
+/// <summary>
+/// Enriches log events with a MachineName property containing <see cref="Environment.MachineName"/>.
+/// </summary>
+class MachineNameEnricher : CachedPropertyEnricher
 {
     /// <summary>
-    /// Enriches log events with a MachineName property containing <see cref="Environment.MachineName"/>.
+    /// The property name added to enriched log events.
     /// </summary>
-    public class MachineNameEnricher : CachedPropertyEnricher
-    {
-        /// <summary>
-        /// The property name added to enriched log events.
-        /// </summary>
-        public const string MachineNamePropertyName = "MachineName";
+    const string MachineNamePropertyName = "MachineName";
 
-        // Qualify as uncommon-path
-        [MethodImpl(MethodImplOptions.NoInlining)]
-        protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
-        {
-#if NETSTANDARD1_3
-            var machineName = Dns.GetHostName();
-#else
-            var machineName = Environment.MachineName;
-#endif
-            return propertyFactory.CreateProperty(MachineNamePropertyName, machineName);
-        }
+    protected override LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
+    {
+        var machineName = Environment.MachineName;
+        return propertyFactory.CreateProperty(MachineNamePropertyName, machineName);
     }
-}
+}