Merge pull request #38 from serilog/dev

2.2.0 Release

README.md

@@ -27,5 +27,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')
 
 Copyright © 2016 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html).

appveyor.yml

@@ -1,6 +1,6 @@
 version: '{build}'
 skip_tags: true
-image: Visual Studio 2017
+image: Visual Studio 2019
 configuration: Release
 install:
   - ps: mkdir -Force ".\build\" | Out-Null
@@ -13,7 +13,7 @@ artifacts:
 deploy:
 - provider: NuGet
   api_key:
-    secure: bd9z4P73oltOXudAjPehwp9iDKsPtC+HbgshOrSgoyQKr5xVK+bxJQngrDJkHdY8
+    secure: j+PjfZXCmLnVDJJreZpM8MPgFEhbaOZ4iwjbLZpG4X+rtNjThwOvsgwXC5QSbUL1
   skip_symbols: true
   on:
     branch: /^(master|dev)$/

src/Serilog.Enrichers.Environment/Enrichers/EnvironmentNameEnricher.cs

@@ -0,0 +1,73 @@
+// Copyright 2013-2018 Serilog Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using Serilog.Core;
+using Serilog.Events;
+using System.Runtime.CompilerServices;
+
+namespace Serilog.Enrichers
+{
+    /// <summary>
+    /// Enriches log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+    /// </summary>
+    public class EnvironmentNameEnricher : ILogEventEnricher
+    {
+        LogEventProperty _cachedProperty;
+
+        /// <summary>
+        /// The property name added to enriched log events.
+        /// </summary>
+        public const string EnvironmentNamePropertyName = "EnvironmentName";
+
+        /// <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));
+        }
+
+        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
+            if (_cachedProperty == null)
+                _cachedProperty = CreateProperty(propertyFactory);
+
+            return _cachedProperty;
+        }
+
+        // Qualify as uncommon-path
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        private static LogEventProperty CreateProperty(ILogEventPropertyFactory propertyFactory)
+        {
+            var environmentName = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
+
+            if (string.IsNullOrWhiteSpace(environmentName))
+            {
+                environmentName = Environment.GetEnvironmentVariable("DOTNET_ENVIRONMENT");
+            }
+
+            if (string.IsNullOrWhiteSpace(environmentName))
+            {
+                environmentName = "Production";
+            }
+
+            return propertyFactory.CreateProperty(EnvironmentNamePropertyName, environmentName);
+        }
+    }
+}

src/Serilog.Enrichers.Environment/EnvironmentLoggerConfigurationExtensions.cs

@@ -23,7 +23,19 @@ namespace Serilog
     /// capabilities.
     /// </summary>
     public static class EnvironmentLoggerConfigurationExtensions
-    { 
+    {
+        /// <summary>
+        /// Enrich log events with a EnvironmentName property containing the value of the ASPNETCORE_ENVIRONMENT or DOTNET_ENVIRONMENT environment variable.
+        /// </summary>
+        /// <param name="enrichmentConfiguration">Logger enrichment configuration.</param>
+        /// <returns>Configuration object allowing method chaining.</returns>
+        public static LoggerConfiguration WithEnvironmentName(
+           this LoggerEnrichmentConfiguration enrichmentConfiguration)
+        {
+            if (enrichmentConfiguration == null) throw new ArgumentNullException(nameof(enrichmentConfiguration));
+            return enrichmentConfiguration.With<EnvironmentNameEnricher>();
+        }
+
         /// <summary>
         /// Enrich log events with a MachineName property containing the current <see cref="Environment.MachineName"/>.
         /// </summary>

src/Serilog.Enrichers.Environment/Serilog.Enrichers.Environment.csproj

@@ -2,9 +2,9 @@
 
   <PropertyGroup>
     <Description>Enrich Serilog log events with properties from System.Environment.</Description>
-    <VersionPrefix>2.1.3</VersionPrefix>
+    <VersionPrefix>2.2.0</VersionPrefix>
     <Authors>Serilog Contributors</Authors>
-    <TargetFrameworks>net45;netstandard1.3;netstandard1.5</TargetFrameworks>
+    <TargetFrameworks>net45;netstandard1.3;netstandard1.5;netstandard2.0</TargetFrameworks>
     <AssemblyName>Serilog.Enrichers.Environment</AssemblyName>
     <AssemblyOriginatorKeyFile>../../assets/Serilog.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
@@ -13,7 +13,7 @@
     <PackageTags>serilog;machine;enricher</PackageTags>
     <PackageIconUrl>http://serilog.net/images/serilog-enricher-nuget.png</PackageIconUrl>
     <PackageProjectUrl>http://serilog.net</PackageProjectUrl>
-    <PackageLicenseUrl>http://www.apache.org/licenses/LICENSE-2.0</PackageLicenseUrl>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <RepositoryUrl>https://github.com/serilog/serilog-enrichers-environment</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
@@ -32,7 +32,7 @@
     <PackageReference Include="System.Net.NameResolution" Version="4.3.0" />
   </ItemGroup>
 
-  <PropertyGroup Condition=" '$(TargetFramework)' == 'net45' ">
+  <PropertyGroup Condition=" '$(TargetFramework)' != 'netstandard1.3' AND '$(TargetFramework)' != 'netstandard1.5' ">
     <DefineConstants>$(DefineConstants);ENV_USER_NAME</DefineConstants>
   </PropertyGroup>
 

test/Serilog.Enrichers.Environment.Tests/Enrichers/EnvironmentEnvironmenNameEnricherTests.cs

@@ -0,0 +1,24 @@
+using Serilog.Events;
+using Serilog.Tests.Support;
+using Xunit;
+
+namespace Serilog.Tests.Enrichers
+{
+    public class EnvironmentEnvironmenNameEnricherTests
+    {
+        [Fact]
+        public void EnvironmentNameEnricherIsApplied()
+        {
+            LogEvent evt = null;
+            var log = new LoggerConfiguration()
+                .Enrich.WithEnvironmentName()
+                .WriteTo.Sink(new DelegatingSink(e => evt = e))
+                .CreateLogger();
+
+            log.Information(@"Has an EnvironmenName property with the value of the DOTNET_ENVIRONMENT or ASPNETCORE_ENVIRONMENT environment variable.");
+
+            Assert.NotNull(evt);
+            Assert.NotEmpty((string)evt.Properties["EnvironmentName"].LiteralValue());
+        }
+    }
+}

test/Serilog.Enrichers.Environment.Tests/Serilog.Enrichers.Environment.Tests.csproj

@@ -1,38 +1,18 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp1.0;net46</TargetFrameworks>
-    <AssemblyName>Serilog.Enrichers.Environment.Tests</AssemblyName>
-    <AssemblyOriginatorKeyFile>../../assets/Serilog.snk</AssemblyOriginatorKeyFile>
-    <SignAssembly>true</SignAssembly>
-    <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
-    <PackageId>Serilog.Enrichers.Environment.Tests</PackageId>
-    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
-    <PackageTargetFallback Condition=" '$(TargetFramework)' == 'netcoreapp1.0' ">$(PackageTargetFallback);dnxcore50;portable-net45+win8</PackageTargetFallback>
-    <RuntimeFrameworkVersion Condition=" '$(TargetFramework)' == 'netcoreapp1.0' ">1.0.4</RuntimeFrameworkVersion>
+    <TargetFrameworks>netcoreapp3.1;net46</TargetFrameworks>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <None Include="App.config" />
-  </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\..\src\Serilog.Enrichers.Environment\Serilog.Enrichers.Environment.csproj" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-preview-20170106-08" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0-beta5-build1225" />
-    <PackageReference Include="xunit" Version="2.2.0-beta5-build3474" />
-  </ItemGroup>
-
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net46' ">
-    <Reference Include="System" />
-    <Reference Include="Microsoft.CSharp" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" PrivateAssets="all" />
+    <PackageReference Include="xunit" Version="2.4.1" />
   </ItemGroup>
 
 </Project>