Merge pull request #10 from serilog/dev

2.1.1 Release (WIP)

README.md

@@ -1,16 +1,31 @@
 # Serilog.Enrichers.Environment
 
-The environment enricher for Serilog.
+Enriches Serilog events with information from the process 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
 ```
 
-* [Documentation](https://github.com/serilog/serilog/wiki)
+Then, apply the enricher to you `LoggerConfiguration`:
+
+```csharp
+Log.Logger = new LoggerConfiguration()
+    .Enrich.WithMachineName()
+    // ...other configuration...
+    .CreateLogger();
+```
+
+The `WithMachineName()` enricher will add a `MachineName` property to produced events.
+
+### Included enrichers
+
+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)
 
 Copyright © 2016 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html).

src/Serilog.Enrichers.Environment/project.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.0-*",
+  "version": "2.1.1-*",
   "description": "Enrich Serilog log events with properties from System.Environment.",
   "authors": [
     "Serilog Contributors"
@@ -25,10 +25,10 @@
     "net4.5": {
       "define": ["ENV_USER_NAME"]
     },
-    "netstandard1.5": {
+    "netstandard1.3": {
       "dependencies": {
         "System.Runtime.Extensions": "4.1.0"
       }
     }
   }
-}
+}

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

@@ -0,0 +1,24 @@
+using Serilog.Events;
+using Serilog.Tests.Support;
+using Xunit;
+
+namespace Serilog.Tests.Enrichers
+{
+    public class EnvironmentMachineNameEnricherTests
+    {
+        [Fact]
+        public void EnvironmentMachineNameEnricherIsApplied()
+        {
+            LogEvent evt = null;
+            var log = new LoggerConfiguration()
+                .Enrich.WithMachineName()
+                .WriteTo.Sink(new DelegatingSink(e => evt = e))
+                .CreateLogger();
+
+            log.Information(@"Has an MachineName property");
+
+            Assert.NotNull(evt);
+            Assert.NotEmpty((string)evt.Properties["MachineName"].LiteralValue());
+        }
+    }
+}

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

@@ -1,6 +1,4 @@
-#if PROCESS
-
-using Serilog.Events;
+using Serilog.Events;
 using Serilog.Tests.Support;
 using Xunit;
 
@@ -24,4 +22,3 @@ public void EnvironmentUserNameEnricherIsApplied()
         }
     }
 }
-#endif

test/Serilog.Enrichers.Environment.Tests/project.json

@@ -1,8 +1,8 @@
-{ 
+{
   "testRunner": "xunit",
-  "dependencies": { 
+  "dependencies": {
     "xunit": "2.1.0",
-    "dotnet-test-xunit": "1.0.0-rc2-build10015",
+    "dotnet-test-xunit": "1.0.0-*",
     "Serilog.Enrichers.Environment": {
       "target": "project"
     }