Feature/add user info description (#11)

* Add user info/description (#10)

* SerilogProperty-AddUserInfo

* update README and Version

* change

* change

Co-authored-by: Brook <yuefengkai@hotmail.com>

* Added examples for #10 and changes for perf

Co-authored-by: Zengzhi Gao <gaozengzhi@gmail.com>
Co-authored-by: Brook <yuefengkai@hotmail.com>

Author: 3 people

sample/SampleWeb/Controllers/ValuesController.cs

@@ -1,6 +1,10 @@
-using System.Diagnostics;
+using System;
+using System.Diagnostics;
+using Exceptionless.Models;
+using Exceptionless.Models.Data;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
+using Serilog.Context;
 
 namespace SampleWeb.Controllers
 {
@@ -18,7 +22,31 @@ public ValuesController(ILogger<ValuesController> logger)
         [HttpGet]
         public string Get()
         {
-            _logger.LogInformation("Get was called");
+           _logger.LogInformation("Get was called");
+            return $"[{Activity.Current?.Id}] {User.Identity?.Name}";
+        }
+        
+        [HttpGet("advanced-topic-user")]
+        public string AdvancedTopicUser()
+        {
+            // This call is is authenticated so a user identity would automatically be set.
+            // However we are overriding it with our own custom user. You may want to do this
+            // in a microservice where you know the user but you may not be authenticated.
+            using (LogContext.PushProperty(Event.KnownDataKeys.UserInfo, new UserInfo(User.Identity?.Name + " Custom", "Test User Full Name"), true)) {
+                _logger.LogInformation("This log event will have a custom user set.");
+            }
+            
+            return $"[{Activity.Current?.Id}] {User.Identity?.Name}";
+        }
+        
+        [HttpGet("advanced-topic-user-description")]
+        public string AdvancedTopicUserDescription(string description)
+        {
+            // User descriptions was intended to provide a description from an end user why an error happened.
+            using (LogContext.PushProperty(Event.KnownDataKeys.UserDescription, new UserDescription(User.Identity?.Name, description), true)) {
+                _logger.LogError(new Exception("Test"), "This error event will have a user description set on it.");
+            }
+            
             return $"[{Activity.Current?.Id}] {User.Identity?.Name}";
         }
     }

sample/SampleWeb/Startup.cs

@@ -40,7 +40,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseRouting();
             app.UseAuthentication();
             app.UseAuthorization();
-            app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
+            app.UseEndpoints(endpoints => endpoints.MapControllers());
         }
     }
 }

src/Serilog.Sinks.Exceptionless/Serilog.Sinks.Exceptionless.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Description>Exceptionless sink for Serilog</Description>
-    <VersionPrefix>3.1.2</VersionPrefix>
+    <VersionPrefix>3.1.3</VersionPrefix>
     <Authors>Serilog Contributors</Authors>
     <TargetFrameworks>net452;netstandard2.0</TargetFrameworks>
     <NoWarn>$(NoWarn);CS1591</NoWarn>

src/Serilog.Sinks.Exceptionless/Sinks/Exceptionless/ExceptionlessClientExtensions.cs

@@ -5,7 +5,8 @@
 using Serilog.Core;
 using Serilog.Events;
 
-namespace Serilog.Sinks.Exceptionless {
+namespace Serilog.Sinks.Exceptionless
+{
     public static class ExceptionlessClientExtensions {
         public static EventBuilder CreateFromLogEvent(this ExceptionlessClient client, LogEvent log) {
             string message = log.RenderMessage();

src/Serilog.Sinks.Exceptionless/Sinks/Exceptionless/ExceptionlessSink.cs

@@ -1,7 +1,10 @@
 using System;
+using System.Collections.Generic;
 using Exceptionless;
 using Exceptionless.Dependency;
 using Exceptionless.Logging;
+using Exceptionless.Models;
+using Exceptionless.Models.Data;
 using Serilog.Core;
 using Serilog.Events;
 
@@ -87,9 +90,39 @@ public void Emit(LogEvent logEvent) {
             var builder = _client.CreateFromLogEvent(logEvent);
 
             if (_includeProperties && logEvent.Properties != null) {
-                foreach (var property in logEvent.Properties)
-                    if (property.Key != Constants.SourceContextPropertyName)
-                        builder.SetProperty(property.Key, property.Value.FlattenProperties());
+                foreach (var prop in logEvent.Properties)
+                {
+                    switch (prop.Key)
+                    {
+                        case Constants.SourceContextPropertyName:
+                            continue;
+                        case Event.KnownDataKeys.UserInfo when prop.Value is StructureValue uis && String.Equals(nameof(UserInfo), uis.TypeTag):
+                            var userInfo = uis.FlattenProperties() as Dictionary<string, object>;
+                            if (userInfo is null)
+                                continue;
+
+                            // UserDescription Data property is currently ignored.
+                            string identity = userInfo[nameof(UserInfo.Identity)] as string;
+                            string name = userInfo[nameof(UserInfo.Name)] as string;
+                            if (!String.IsNullOrWhiteSpace(identity) || !String.IsNullOrWhiteSpace(name))
+                                builder.SetUserIdentity(identity, name);
+                            break;
+                        case Event.KnownDataKeys.UserDescription when prop.Value is StructureValue uds && String.Equals(nameof(UserDescription), uds.TypeTag):
+                            var userDescription = uds.FlattenProperties() as Dictionary<string, object>;
+                            if (userDescription is null)
+                                continue;
+
+                            // UserDescription Data property is currently ignored.
+                            string emailAddress = userDescription[nameof(UserDescription.EmailAddress)] as string;
+                            string description = userDescription[nameof(UserDescription.Description)] as string;
+                            if (!String.IsNullOrWhiteSpace(emailAddress) || !String.IsNullOrWhiteSpace(description))
+                                builder.SetUserDescription(emailAddress, description);
+                            break;
+                        default: 
+                            builder.SetProperty(prop.Key, prop.Value.FlattenProperties());
+                            break;
+                    }
+                }
             }
 
             _additionalOperation?.Invoke(builder);