Introduce IBufferedLogger

src/libraries/Microsoft.Extensions.Logging.Abstractions/ref/Microsoft.Extensions.Logging.Abstractions.cs

@@ -202,4 +202,23 @@ public NullLogger() { }
         public bool IsEnabled(Microsoft.Extensions.Logging.LogLevel logLevel) { throw null; }
         public void Log<TState>(Microsoft.Extensions.Logging.LogLevel logLevel, Microsoft.Extensions.Logging.EventId eventId, TState state, System.Exception? exception, System.Func<TState, System.Exception?, string> formatter) { }
     }
+    public abstract class BufferedLogRecord
+    {
+        public abstract System.DateTimeOffset Timestamp { get; }
+        public abstract Microsoft.Extensions.Logging.LogLevel LogLevel { get; }
+        public abstract EventId EventId { get; }
+        public abstract string? Exception { get; }
+#if NET8_0_OR_GREATER
+        public abstract System.Diagnostics.ActivitySpanId ActivitySpanId { get; }
+        public abstract System.Diagnostics.ActivityTraceId ActivityTraceId { get; }
+#endif
+        public abstract int? ManagedThreadId { get; }
+        public abstract string? FormattedMessage { get; }
+        public abstract string? MessageTemplate { get; }
+        public abstract System.Collections.Generic.IReadOnlyList<System.Collections.Generic.KeyValuePair<string, object?>> Attributes { get; }
+    }
+    public interface IBufferedLogger
+    {
+        void Log(System.Collections.Generic.IReadOnlyList<Microsoft.Extensions.Logging.Abstractions.BufferedLogRecord> records);
+    }
 }

src/libraries/Microsoft.Extensions.Logging.Abstractions/src/BufferedLogRecord.cs

@@ -0,0 +1,71 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+
+namespace Microsoft.Extensions.Logging
+{
+    /// <summary>
+    /// State representing a buffered log record.
+    /// </summary>
+    /// <remarks>
+    /// Objects of this type are reused over time to reduce
+    /// allocations.
+    /// </remarks>
+    public abstract class BufferedLogRecord
+    {
+        /// <summary>
+        /// Gets the time when the log record was first created.
+        /// </summary>
+        public abstract DateTimeOffset Timestamp { get; }
+
+        /// <summary>
+        /// Gets the record's log level, indicating it rough importance
+        /// </summary>
+        public abstract LogLevel LogLevel { get; }
+
+        /// <summary>
+        /// Gets the records event id.
+        /// </summary>
+        public abstract EventId EventId { get; }
+
+        /// <summary>
+        /// Gets an optional exception string for this record.
+        /// </summary>
+        public abstract string? Exception { get; }
+
+#if NET8_0_OR_GREATER
+        /// <summary>
+        /// Gets an activity span id for this record, representing the state of the thread that created the record.
+        /// </summary>
+        public abstract ActivitySpanId ActivitySpanId { get; }
+
+        /// <summary>
+        /// Gets an activity trace id for this record, representing the state of the thread that created the record.
+        /// </summary>
+        public abstract ActivityTraceId ActivityTraceId { get; }
+#endif
+
+        /// <summary>
+        /// Gets the ID of the thread that created the log record.
+        /// </summary>
+        public abstract int? ManagedThreadId { get; }
+
+        /// <summary>
+        /// Gets the formatted log message.
+        /// </summary>
+        public abstract string? FormattedMessage { get; }
+
+        /// <summary>
+        /// Gets the original log message template.
+        /// </summary>
+        public abstract string? MessageTemplate { get; }
+
+        /// <summary>
+        /// Gets the variable set of name/value pairs associated with the record.
+        /// </summary>
+        public abstract IReadOnlyList<KeyValuePair<string, object?>> Attributes { get; }
+    }
+}

src/libraries/Microsoft.Extensions.Logging.Abstractions/src/IBufferedLogger.cs

@@ -0,0 +1,37 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Generic;
+
+namespace Microsoft.Extensions.Logging
+{
+    /// <summary>
+    /// Logging providers can implement this interface to indicate they support buffered logging.
+    /// </summary>
+    /// <remarks>
+    /// A logging provider normally exposes an <see cref="ILogger" /> interface that gets invoked by the
+    /// logging infrastructure whenever it’s time to log a piece of state.
+    ///
+    /// The logging infrastructure will type-test the <c>ILogger</c> object to determine if
+    /// it supports the <c>IBufferedLogger</c> interface also. If it does, that tells the
+    /// logging infrastructure that the logging provider supports buffering. Whenever log
+    /// buffering is enabled, buffered log records will be delivered to the logging provider
+    /// via the <c>IBufferedLogger</c> interface.
+    ///
+    /// If a logging provider does not support log buffering, then it will always be given
+    /// unbuffered log records. In other words, whether or not buffering is requested by
+    /// the user, it will not happen for those log providers.
+    /// </remarks>
+    public interface IBufferedLogger
+    {
+        /// <summary>
+        /// Delivers a batch of buffered log records to a logging provider.
+        /// </summary>
+        /// <param name="records">The buffered log records to log.</param>
+        /// <remarks>
+        /// Once this function returns, it should no longer access the records
+        /// or state referenced by these records.
+        /// </remarks>
+        void Log(IReadOnlyList<BufferedLogRecord> records);
+    }
+}

src/libraries/Microsoft.Extensions.Logging.Abstractions/src/Microsoft.Extensions.Logging.Abstractions.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+  <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppPrevious);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>
@@ -51,6 +51,7 @@ Microsoft.Extensions.Logging.Abstractions.NullLogger</PackageDescription>
     <ProjectReference Include="..\gen\Microsoft.Extensions.Logging.Generators.Roslyn4.4.csproj"
                       ReferenceOutputAssembly="false"
                       PackAsAnalyzer="true" />
+    <ProjectReference Include="$(LibrariesProjectRoot)System.Diagnostics.DiagnosticSource\src\System.Diagnostics.DiagnosticSource.csproj" /> 
   </ItemGroup>
 
 </Project>

src/libraries/Microsoft.Extensions.Logging.Abstractions/src/src.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.002.0
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Extensions.Logging.Abstractions", "Microsoft.Extensions.Logging.Abstractions.csproj", "{2C37E902-3EB9-4E48-82DB-9D4C4BB6AAD0}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{2C37E902-3EB9-4E48-82DB-9D4C4BB6AAD0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2C37E902-3EB9-4E48-82DB-9D4C4BB6AAD0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2C37E902-3EB9-4E48-82DB-9D4C4BB6AAD0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2C37E902-3EB9-4E48-82DB-9D4C4BB6AAD0}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {69124FB1-1525-4BBA-AB0C-0E6753566E44}
+	EndGlobalSection
+EndGlobal

src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleFormatter.cs

@@ -32,7 +32,7 @@ protected ConsoleFormatter(string name)
         /// Writes the log message to the specified TextWriter.
         /// </summary>
         /// <remarks>
-        /// if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
+        /// If the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
         /// </remarks>
         /// <param name="logEntry">The log entry.</param>
         /// <param name="scopeProvider">The provider of scope data.</param>

src/libraries/Microsoft.Extensions.Logging.Console/src/ConsoleLogger.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Runtime.Versioning;
@@ -13,7 +14,7 @@ namespace Microsoft.Extensions.Logging.Console
     /// A logger that writes messages in the console.
     /// </summary>
     [UnsupportedOSPlatform("browser")]
-    internal sealed class ConsoleLogger : ILogger
+    internal sealed class ConsoleLogger : ILogger, IBufferedLogger
     {
         private readonly string _name;
         private readonly ConsoleLoggerProcessor _queueProcessor;
@@ -69,6 +70,33 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
             _queueProcessor.EnqueueMessage(new LogMessageEntry(computedAnsiString, logAsError: logLevel >= Options.LogToStandardErrorThreshold));
         }
 
+        /// <inheritdoc />
+        public void Log(IReadOnlyList<BufferedLogRecord> records)
+        {
+            ThrowHelper.ThrowIfNull(records);
+
+            t_stringWriter ??= new StringWriter();
+
+            foreach (var rec in records)
+            {
+                var logEntry = new LogEntry<BufferedLogRecord>(rec.LogLevel, _name, rec.EventId, rec, null, (s, e) => s.FormattedMessage ?? string.Empty);
+                Formatter.Write(in logEntry, null, t_stringWriter);
+
+                var sb = t_stringWriter.GetStringBuilder();
+                if (sb.Length == 0)
+                {
+                    continue;
+                }
+                string computedAnsiString = sb.ToString();
+                sb.Clear();
+                if (sb.Capacity > 1024)
+                {
+                    sb.Capacity = 1024;
+                }
+                _queueProcessor.EnqueueMessage(new LogMessageEntry(computedAnsiString, logAsError: rec.LogLevel >= Options.LogToStandardErrorThreshold));
+            }
+        }
+
         /// <inheritdoc />
         public bool IsEnabled(LogLevel logLevel)
         {

src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatter.cs

@@ -28,20 +28,37 @@ public JsonConsoleFormatter(IOptionsMonitor<JsonConsoleFormatterOptions> options
 
         public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider? scopeProvider, TextWriter textWriter)
         {
-            string message = logEntry.Formatter(logEntry.State, logEntry.Exception);
-            if (logEntry.Exception == null && message == null)
+            if (logEntry.State is BufferedLogRecord bufferedRecord)
             {
-                return;
+                string message = bufferedRecord.FormattedMessage ?? string.Empty;
+                if (bufferedRecord.Exception == null && message == null)
+                {
+                    return;
+                }
+
+                WriteInternal(scopeProvider, textWriter, message, bufferedRecord.LogLevel, logEntry.Category, bufferedRecord.EventId.Id, bufferedRecord.Exception,
+                    bufferedRecord.Attributes.Count > 0, null, bufferedRecord.Attributes as IReadOnlyList<KeyValuePair<string, object?>>, bufferedRecord.Timestamp);
             }
+            else
+            {
+                string message = logEntry.Formatter(logEntry.State, logEntry.Exception);
+                if (logEntry.Exception == null && message == null)
+                {
+                    return;
+                }
 
-            // We extract most of the work into a non-generic method to save code size. If this was left in the generic
-            // method, we'd get generic specialization for all TState parameters, but that's unnecessary.
-            WriteInternal(scopeProvider, textWriter, message, logEntry.LogLevel, logEntry.Category, logEntry.EventId.Id, logEntry.Exception,
-                logEntry.State != null, logEntry.State?.ToString(), logEntry.State as IReadOnlyCollection<KeyValuePair<string, object>>);
+                DateTimeOffset stamp = FormatterOptions.UseUtcTimestamp ? DateTimeOffset.UtcNow : DateTimeOffset.Now;
+
+                // We extract most of the work into a non-generic method to save code size. If this was left in the generic
+                // method, we'd get generic specialization for all TState parameters, but that's unnecessary.
+                WriteInternal(scopeProvider, textWriter, message, logEntry.LogLevel, logEntry.Category, logEntry.EventId.Id, logEntry.Exception?.ToString(),
+                    logEntry.State != null, logEntry.State?.ToString(), logEntry.State as IReadOnlyList<KeyValuePair<string, object?>>, stamp);
+            }
         }
 
-        private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter textWriter, string message, LogLevel logLevel,
-            string category, int eventId, Exception? exception, bool hasState, string? stateMessage, IReadOnlyCollection<KeyValuePair<string, object>>? stateProperties)
+        private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter textWriter, string? message, LogLevel logLevel,
+            string category, int eventId, string? exception, bool hasState, string? stateMessage, IReadOnlyList<KeyValuePair<string, object?>>? stateProperties,
+            DateTimeOffset stamp)
         {
             const int DefaultBufferSize = 1024;
             using (var output = new PooledByteBufferWriter(DefaultBufferSize))
@@ -52,8 +69,7 @@ private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter tex
                     var timestampFormat = FormatterOptions.TimestampFormat;
                     if (timestampFormat != null)
                     {
-                        DateTimeOffset dateTimeOffset = FormatterOptions.UseUtcTimestamp ? DateTimeOffset.UtcNow : DateTimeOffset.Now;
-                        writer.WriteString("Timestamp", dateTimeOffset.ToString(timestampFormat));
+                        writer.WriteString("Timestamp", stamp.ToString(timestampFormat));
                     }
                     writer.WriteNumber(nameof(LogEntry<object>.EventId), eventId);
                     writer.WriteString(nameof(LogEntry<object>.LogLevel), GetLogLevelString(logLevel));
@@ -62,7 +78,7 @@ private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter tex
 
                     if (exception != null)
                     {
-                        writer.WriteString(nameof(Exception), exception.ToString());
+                        writer.WriteString(nameof(Exception), exception);
                     }
 
                     if (hasState)
@@ -71,7 +87,7 @@ private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter tex
                         writer.WriteString("Message", stateMessage);
                         if (stateProperties != null)
                         {
-                            foreach (KeyValuePair<string, object> item in stateProperties)
+                            foreach (KeyValuePair<string, object?> item in stateProperties)
                             {
                                 WriteItem(writer, item);
                             }
@@ -131,11 +147,11 @@ private void WriteScopeInformation(Utf8JsonWriter writer, IExternalScopeProvider
                 writer.WriteStartArray("Scopes");
                 scopeProvider.ForEachScope((scope, state) =>
                 {
-                    if (scope is IEnumerable<KeyValuePair<string, object>> scopeItems)
+                    if (scope is IEnumerable<KeyValuePair<string, object?>> scopeItems)
                     {
                         state.WriteStartObject();
                         state.WriteString("Message", scope.ToString());
-                        foreach (KeyValuePair<string, object> item in scopeItems)
+                        foreach (KeyValuePair<string, object?> item in scopeItems)
                         {
                             WriteItem(state, item);
                         }
@@ -150,7 +166,7 @@ private void WriteScopeInformation(Utf8JsonWriter writer, IExternalScopeProvider
             }
         }
 
-        private static void WriteItem(Utf8JsonWriter writer, KeyValuePair<string, object> item)
+        private static void WriteItem(Utf8JsonWriter writer, KeyValuePair<string, object?> item)
         {
             var key = item.Key;
             switch (item.Value)

src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatter.cs

@@ -46,19 +46,32 @@ public void Dispose()
 
         public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider? scopeProvider, TextWriter textWriter)
         {
-            string message = logEntry.Formatter(logEntry.State, logEntry.Exception);
-            if (logEntry.Exception == null && message == null)
+            if (logEntry.State is BufferedLogRecord bufferedRecord)
             {
-                return;
+                string message = bufferedRecord.FormattedMessage ?? string.Empty;
+                if (bufferedRecord.Exception == null && message == null)
+                {
+                    return;
+                }
+
+                WriteInternal(scopeProvider, textWriter, message, bufferedRecord.LogLevel, bufferedRecord.EventId.Id, bufferedRecord.Exception, logEntry.Category, bufferedRecord.Timestamp);
             }
+            else
+            {
+                string message = logEntry.Formatter(logEntry.State, logEntry.Exception);
+                if (logEntry.Exception == null && message == null)
+                {
+                    return;
+                }
 
-            // We extract most of the work into a non-generic method to save code size. If this was left in the generic
-            // method, we'd get generic specialization for all TState parameters, but that's unnecessary.
-            WriteInternal(scopeProvider, textWriter, message, logEntry.LogLevel, logEntry.EventId.Id, logEntry.Exception, logEntry.Category);
+                // We extract most of the work into a non-generic method to save code size. If this was left in the generic
+                // method, we'd get generic specialization for all TState parameters, but that's unnecessary.
+                WriteInternal(scopeProvider, textWriter, message, logEntry.LogLevel, logEntry.EventId.Id, logEntry.Exception?.ToString(), logEntry.Category, GetCurrentDateTime());
+            }
         }
 
         private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter textWriter, string message, LogLevel logLevel,
-            int eventId, Exception? exception, string category)
+            int eventId, string? exception, string category, DateTimeOffset stamp)
         {
             ConsoleColors logLevelColors = GetLogLevelConsoleColors(logLevel);
             string logLevelString = GetLogLevelString(logLevel);
@@ -67,8 +80,7 @@ private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter tex
             string? timestampFormat = FormatterOptions.TimestampFormat;
             if (timestampFormat != null)
             {
-                DateTimeOffset dateTimeOffset = GetCurrentDateTime();
-                timestamp = dateTimeOffset.ToString(timestampFormat);
+                timestamp = stamp.ToString(timestampFormat);
             }
             if (timestamp != null)
             {
@@ -114,7 +126,7 @@ private void WriteInternal(IExternalScopeProvider? scopeProvider, TextWriter tex
             if (exception != null)
             {
                 // exception message
-                WriteMessage(textWriter, exception.ToString(), singleLine);
+                WriteMessage(textWriter, exception, singleLine);
             }
             if (singleLine)
             {