#5373 - Added custom extension method to configure the file serilog file sink to be wrapped in the async sink

src/Umbraco.Core/Logging/Serilog/LoggerConfigExtensions.cs

@@ -1,7 +1,11 @@
 using System;
+using System.Text;
 using System.Web;
 using Serilog;
+using Serilog.Configuration;
+using Serilog.Core;
 using Serilog.Events;
+using Serilog.Formatting;
 using Serilog.Formatting.Compact;
 using Umbraco.Core.Logging.Serilog.Enrichers;
 
@@ -35,7 +39,7 @@ namespace Umbraco.Core.Logging.Serilog
                 .Enrich.With<HttpSessionIdEnricher>()
                 .Enrich.With<HttpRequestNumberEnricher>()
                 .Enrich.With<HttpRequestIdEnricher>();
-            
+
             return logConfig;
         }
 
@@ -50,15 +54,63 @@ namespace Umbraco.Core.Logging.Serilog
             //Main .txt logfile - in similar format to older Log4Net output
             //Ends with ..txt as Date is inserted before file extension substring
             logConfig.WriteTo.File($@"{AppDomain.CurrentDomain.BaseDirectory}\App_Data\Logs\UmbracoTraceLog.{Environment.MachineName}..txt",
-                    shared: true,
-                    rollingInterval: RollingInterval.Day,
-                    restrictedToMinimumLevel: minimumLevel,
-                    retainedFileCountLimit: null, //Setting to null means we keep all files - default is 31 days
-                    outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss,fff} [P{ProcessId}/D{AppDomainId}/T{ThreadId}] {Log4NetLevel}  {SourceContext} - {Message:lj}{NewLine}{Exception}");
+                shared: true,
+                rollingInterval: RollingInterval.Day,
+                restrictedToMinimumLevel: minimumLevel,
+                retainedFileCountLimit: null, //Setting to null means we keep all files - default is 31 days
+                outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss,fff} [P{ProcessId}/D{AppDomainId}/T{ThreadId}] {Log4NetLevel}  {SourceContext} - {Message:lj}{NewLine}{Exception}");
 
             return logConfig;
         }
 
+
+        /// <remarks>
+        ///    Used in config - If renamed or moved to other assembly the config file also has be updated.
+        /// </remarks>
+        public static LoggerConfiguration File(this LoggerSinkConfiguration configuration, ITextFormatter formatter,
+            string path,
+            bool shared = false,
+            bool buffered = false,
+            LogEventLevel restrictedToMinimumLevel = LogEventLevel.Verbose,
+            LoggingLevelSwitch levelSwitch = null,
+            long? fileSizeLimitBytes = 1073741824,
+            TimeSpan? flushToDiskInterval = null,
+            RollingInterval rollingInterval = RollingInterval.Infinite,
+            bool rollOnFileSizeLimit = false,
+            int? retainedFileCountLimit = 31,
+            Encoding encoding = null,
+            bool async = false,
+            bool asyncBlockWhenFull = false,
+            int asyncBufferSize = 10000)
+        {
+            LoggerConfiguration GetFileSink(LoggerSinkConfiguration c)
+            {
+                return c.File(
+                    formatter,
+                    path,
+                    restrictedToMinimumLevel,
+                    fileSizeLimitBytes,
+                    levelSwitch,
+                    buffered,
+                    shared,
+                    flushToDiskInterval,
+                    rollingInterval,
+                    rollOnFileSizeLimit,
+                    retainedFileCountLimit,
+                    encoding);
+            }
+
+            if ( async )
+            {
+
+                return configuration.Async(c => GetFileSink(c), blockWhenFull: asyncBlockWhenFull, bufferSize: asyncBufferSize);
+            }
+            else
+            {
+                return GetFileSink(configuration);
+            }
+        }
+
         /// <summary>
         /// Outputs a CLEF format JSON log at /App_Data/Logs/
         /// </summary>

src/Umbraco.Web.UI/config/serilog.Release.config

@@ -17,13 +17,14 @@
 
         <!-- Default JSON log file -->
         <!-- This is used by the default log viewer in the Umbraco backoffice -->
-        <add key="serilog:using:File" value="Serilog.Sinks.File" />
+        <add key="serilog:using:File" value="Umbraco.Core" />
         <add key="serilog:write-to:File.formatter" value="Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact" />
         <add key="serilog:write-to:File.path" value="%BASEDIR%\App_Data\Logs\UmbracoTraceLog.%MACHINENAME%..json" />
         <add key="serilog:write-to:File.shared" value="true" />
         <add key="serilog:write-to:File.restrictedToMinimumLevel" value="Debug" />
         <add key="serilog:write-to:File.retainedFileCountLimit" value="" /> <!-- Number of log files to keep (or remove value to keep all files) -->
         <add key="serilog:write-to:File.rollingInterval" value="Day" /> <!-- Create a new log file every Minute/Hour/Day/Month/Year/infinite -->
+        <add key="serilog:write-to:File.async" value="true" />
 
         <!-- Optional TXT log file -->
         <!--<add key="serilog:using:File" value="Serilog.Sinks.File" /> -->