log context-info if available

Author: hoseinzadehashraf

Olive/Logging/FileLogger/BatchingLogger.cs

@@ -34,6 +34,9 @@ public virtual void Log<TState>(DateTimeOffset timestamp, LogLevel logLevel, Eve
 
             if (exception != null) r.AppendLine(exception.ToFullMessage());
 
+            var contextInfo = Olive.Log.ContextProvider?.Invoke();
+            if (contextInfo.HasValue()) r.AppendLine(contextInfo);
+
             Provider.AddMessage(timestamp, r.ToString(), exception?.GetUsefulStack(), (int)logLevel);
         }
 

Olive/Logging/Log.cs

@@ -3,16 +3,17 @@
 using Microsoft.Extensions.Logging;
 using System;
 using System.ComponentModel;
+using System.Security.Claims;
 using System.Text;
 
 namespace Olive
 {
     public static class LogExtensions
     {
-        public static ILoggingBuilder AddFile(this ILoggingBuilder @this, Action<FileLoggerOptions> configure = null)
+        public static ILoggingBuilder AddFile(this ILoggingBuilder @this, Action<FileLoggerOptions> configure = null)
         {
-            @this.Services.AddSingleton<ILoggerProvider, FileLoggerProvider>();
-            if (configure != null) @this.Services.Configure(configure);
+            @this.Services.AddSingleton<ILoggerProvider, FileLoggerProvider>();
+            if (configure != null) @this.Services.Configure(configure);
             return @this;
         }
 
@@ -53,7 +54,7 @@ static string ToYaml(string description, object relatedObject, string userId, st
             {
                 r.Append("  Description: ");
                 var firstLine = true;
-
+
                 foreach (var line in description.ToLines().Trim())
                 {
                     if (!firstLine) r.Append("  Description: ".Length);
@@ -70,6 +71,11 @@ public static class Log
     {
         public static ILoggerFactory Factory { get; private set; }
 
+        /// <summary>
+        /// When set, provides contextual information (e.g. UserId, RequestUrl, UserIP) to append to log entries.
+        /// </summary>
+        public static Func<string> ContextProvider { get; set; }
+
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static void Init(Action<ILoggingBuilder> configure = null)
         {
@@ -97,6 +103,57 @@ public static void Init(ILoggerFactory factory)
         {
             if (Factory != null) return;
             Factory = factory;
+            InitDefaultContextProvider();
+        }
+
+        static void InitDefaultContextProvider()
+        {
+            var httpContextAccessorType = Type.GetType(
+                "Microsoft.AspNetCore.Http.IHttpContextAccessor, Microsoft.AspNetCore.Http.Abstractions");
+
+            if (httpContextAccessorType == null) return;
+
+            var httpContextProp = httpContextAccessorType.GetProperty("HttpContext");
+
+            ContextProvider = () =>
+            {
+                try
+                {
+                    var accessor = Context.Current.GetOptionalService(httpContextAccessorType);
+                    if (accessor == null) return null;
+
+                    var httpContext = httpContextProp?.GetValue(accessor);
+                    if (httpContext == null) return null;
+
+                    var contextType = httpContext.GetType();
+
+                    var user = contextType.GetProperty("User")?.GetValue(httpContext) as ClaimsPrincipal;
+                    var userId = user?.GetId();
+
+                    var request = contextType.GetProperty("Request")?.GetValue(httpContext);
+                    string requestUrl = null;
+                    if (request != null)
+                    {
+                        var reqType = request.GetType();
+                        var pathBase = reqType.GetProperty("PathBase")?.GetValue(request)?.ToString();
+                        var path = reqType.GetProperty("Path")?.GetValue(request)?.ToString();
+                        var queryString = reqType.GetProperty("QueryString")?.GetValue(request)?.ToString();
+                        requestUrl = $"{pathBase}{path}{queryString}";
+                    }
+
+                    var connection = contextType.GetProperty("Connection")?.GetValue(httpContext);
+                    var userIp = connection?.GetType().GetProperty("RemoteIpAddress")?.GetValue(connection)?.ToString();
+
+                    if (userId.IsEmpty() && requestUrl.IsEmpty() && userIp.IsEmpty()) return null;
+
+                    var r = new StringBuilder();
+                    if (userId.HasValue()) r.AppendLine($"  UserId: {userId}");
+                    if (requestUrl.HasValue()) r.AppendLine($"  RequestUrl: {requestUrl}");
+                    if (userIp.HasValue()) r.AppendLine($"  UserIP: {userIp}");
+                    return r.ToString().TrimEnd();
+                }
+                catch { return null; }
+            };
         }
         public static bool AddProvider<TProvider>() where TProvider : ILoggerProvider
         {

Olive/Olive.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>netstandard2.0</TargetFramework>
-		<Version>8.3.0</Version>
+		<Version>8.3.1</Version>
 		<OutputType>Library</OutputType>
 		<LangVersion>latest</LangVersion>
 		<Authors>Geeks Ltd, UK</Authors>