Added log flush timer capability

Author: dei79

dotNet/CoreHelpers.TaskLogging.Sample/Program.cs

@@ -10,7 +10,7 @@
 HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
 
 // add the azure storage table logger
-builder.Services.AddTaskLoggerForAzureStorageTable("UseDevelopmentStorage=true", "Dev", 100);
+builder.Services.AddTaskLoggerForAzureStorageTable("UseDevelopmentStorage=true", "Dev", 100, TimeSpan.FromSeconds(30));
 
 // register the task logger framework
 builder.Services.AddLogging(

dotNet/CoreHelpers.TaskLogging.Sample/Worker.cs

@@ -1,6 +1,7 @@
 using System;
 using Microsoft.Extensions.Logging;
 using CoreHelpers.Extensions.Logging.Tasks;
+using Microsoft.Extensions.Hosting;
 
 namespace CoreHelpers.TaskLogging.Sample
 {
@@ -9,13 +10,15 @@ internal class Worker
 		private readonly ILogger<Worker> _logger;
 		private readonly IEnumerable<IProcessor> _processors;
         private readonly ITaskLoggerFactory _taskLoggerFactory;
-
-        public Worker(ILogger<Worker> logger, IEnumerable<IProcessor> processors, ITaskLoggerFactory taskLoggerFactory)
+        private readonly IHostApplicationLifetime _appLifetime;
+        
+        public Worker(ILogger<Worker> logger, IEnumerable<IProcessor> processors, ITaskLoggerFactory taskLoggerFactory, IHostApplicationLifetime appLifetime)
 		{
 			_logger = logger;
 			_processors = processors;
             _taskLoggerFactory = taskLoggerFactory;
-        }
+            _appLifetime = appLifetime;
+		}
 
 		public async Task Process()
 		{           
@@ -45,6 +48,36 @@ public async Task Process()
             {
                 await _processors.Where(p => p is ProcessorSuccess).First().Execute();
             }
+            
+            // execute the success processor
+            using (var typedLoggerTaskScope = _logger.BeginNewTaskScope("successjob", "q", "w"))
+            {
+	            // in the scope of the task a shutdown handler will be registered
+	            _appLifetime.ApplicationStopping.Register(() =>
+	            {
+		            _logger.LogError("We are shutting down the application");
+					if (typedLoggerTaskScope != null)
+						typedLoggerTaskScope.Dispose();
+					
+	            });
+	            
+	            // log something
+	            _logger.LogInformation("Will be logged in the timespan");
+	            await Task.Delay(TimeSpan.FromSeconds(60));
+	            
+	            // log something
+	            _logger.LogInformation(("Logging something we should see after graceful shurtdown"));
+	            
+	            // trigger a graceful shutdown
+	            _appLifetime.StopApplication();
+	            
+	            // prevent the application code to leave the scope
+	            await Task.Delay(TimeSpan.FromHours(1));
+	            
+	            // log something we never see again
+	            _logger.LogInformation(("This should never be shown"));
+            }
+            
         }
     }
 }

dotNet/CoreHelpers.TaskLogging/AzureStorageTableTaskLogger.cs

@@ -8,8 +8,8 @@ internal class AzureStorageTableTaskLogger : BaseTaskLogger
     {
         private AzureStorageTableTaskLoggerFactory _loggerFactory;        
 
-        public AzureStorageTableTaskLogger(string taskId, int cacheLimit, AzureStorageTableTaskLoggerFactory loggerFactory)
-            : base(taskId, cacheLimit)
+        public AzureStorageTableTaskLogger(string taskId, int cacheLimit, TimeSpan cacheTimespan, AzureStorageTableTaskLoggerFactory loggerFactory)
+            : base(taskId, cacheLimit, cacheTimespan)
 		{
             _loggerFactory = loggerFactory;            
         }

dotNet/CoreHelpers.TaskLogging/AzureStorageTableTaskLoggerFactory.cs

@@ -11,16 +11,18 @@ namespace CoreHelpers.TaskLogging
 {
     internal class AzureStorageTableTaskLoggerFactory : ITaskLoggerFactory
     {
-        private int _cacheLimit;        
-        private string _environmentPrefix;
-        private TableServiceClient _tableServiceClient;
+        private readonly int _cacheLimit;
+        private readonly TimeSpan _cacheTimespan;
+        private readonly string _environmentPrefix;
+        private readonly TableServiceClient _tableServiceClient;
         private long _messageTimeStampCounter = 0;
 
-        public AzureStorageTableTaskLoggerFactory(string connectionString, string environmentPrefix, int cacheLimit)
+        public AzureStorageTableTaskLoggerFactory(string connectionString, string environmentPrefix, int cacheLimit, TimeSpan cacheTimespan)
         {            
             _tableServiceClient = new TableServiceClient(connectionString);
             _environmentPrefix = environmentPrefix;
-            _cacheLimit = cacheLimit;            
+            _cacheLimit = cacheLimit;
+            _cacheTimespan = cacheTimespan;
         }
 
         public async Task<string> AnnounceTask(string taskType, string taskSource, string taskWorker)
@@ -99,7 +101,7 @@ public async Task UpdateTaskStatus(string taskKey, TaskStatus taskStatus)
 
         public ITaskLogger CreateTaskLogger(string taskKey)
         {
-            return new AzureStorageTableTaskLogger(taskKey, _cacheLimit, this);
+            return new AzureStorageTableTaskLogger(taskKey, _cacheLimit, _cacheTimespan, this);
         }
 
         public async Task Flush(DateTimeOffset flushTime, string taskKey, IEnumerable<string> messages)
@@ -207,7 +209,13 @@ public static class AzureStorageTableTaskLoggerFactoryServiceCollectionExtension
     {
         public static IServiceCollection AddTaskLoggerForAzureStorageTable(this IServiceCollection services, string connectionString, string environmentPrefix, int lineCacheLimit) 
         {
-            services.AddSingleton<ITaskLoggerFactory>(new AzureStorageTableTaskLoggerFactory(connectionString, environmentPrefix, lineCacheLimit));
+            services.AddSingleton<ITaskLoggerFactory>(new AzureStorageTableTaskLoggerFactory(connectionString, environmentPrefix, lineCacheLimit, TimeSpan.FromMinutes(5)));
+            return services;
+        }
+        
+        public static IServiceCollection AddTaskLoggerForAzureStorageTable(this IServiceCollection services, string connectionString, string environmentPrefix, int lineCacheLimit, TimeSpan cacheTimeSpan) 
+        {
+            services.AddSingleton<ITaskLoggerFactory>(new AzureStorageTableTaskLoggerFactory(connectionString, environmentPrefix, lineCacheLimit, cacheTimeSpan));
             return services;
         }
     }

dotNet/CoreHelpers.TaskLogging/BaseTaskLogger.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
 
@@ -8,13 +9,19 @@ namespace CoreHelpers.TaskLogging
 	internal abstract class BaseTaskLogger : ITaskLogger
     {
         private int _cacheLimit;
+        private readonly TimeSpan _cacheTimeSpan;
         private string _taskId;
         private List<string> _messages = new List<string>();
-
-        public BaseTaskLogger(string taskId, int cacheLimit)
+        private readonly Timer _flushTimer;
+        
+        public BaseTaskLogger(string taskId, int cacheLimit, TimeSpan cacheTimeSpan)
         {
             _taskId = taskId;
             _cacheLimit = cacheLimit;
+            _cacheTimeSpan = cacheTimeSpan;
+            _flushTimer = new Timer((state) => {
+                FlushInternal();
+            }, null, _cacheTimeSpan, _cacheTimeSpan);
         }
 
         public void Log(TaskLogLevel logLevel, string message, Exception? exception)
@@ -38,6 +45,7 @@ public void Log(TaskLogLevel logLevel, string message, Exception? exception, Fun
                     _messages.Add(formatter(message, exception));
                 }
 
+                
                 // flush if needed
                 if (_messages.Count >= _cacheLimit)
                     FlushInternal();
@@ -47,8 +55,9 @@ public void Log(TaskLogLevel logLevel, string message, Exception? exception, Fun
         public void Dispose()
         {
             FlushInternal();
+            _flushTimer.Dispose();
         }
-
+        
         private void FlushInternal()
         {
             lock(_messages)