feat: Implement simple in-memory Serilog sink. (#1657)

Author: jaffinito

src/Agent/NewRelic/Agent/Core/Logging/InMemorySink.cs

@@ -0,0 +1,45 @@
+// Copyright 2020 New Relic, Inc. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+using System;
+using Serilog.Core;
+using Serilog.Events;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+
+namespace NewRelic.Agent.Core.Logging
+{
+    public class InMemorySink : ILogEventSink, IDisposable
+    {
+        private readonly ConcurrentQueue<LogEvent> _logEvents;
+
+        public InMemorySink()
+        {
+            _logEvents = new ConcurrentQueue<LogEvent>();
+        }
+
+        public void Emit(LogEvent logEvent)
+        {
+            _logEvents.Enqueue(logEvent);
+        }
+
+        public IEnumerable<LogEvent> LogEvents
+        {
+            get
+            {
+                return _logEvents;
+            }
+        }
+
+        public void Clear()
+        {
+            while (_logEvents.TryDequeue(out _))
+            { }
+        }
+
+        public void Dispose()
+        {
+            Clear();
+        }
+    }
+}

src/Agent/NewRelic/Agent/Core/Logging/LoggerBootstrapper.cs

@@ -10,6 +10,7 @@
 using Serilog.Core;
 using Serilog.Formatting;
 using Logger = NewRelic.Agent.Core.Logging.Logger;
+using NewRelic.Agent.Core.Logging;
 
 namespace NewRelic.Agent.Core
 {
@@ -42,6 +43,8 @@ public static class LoggerBootstrapper
 
         private static LoggingLevelSwitch _loggingLevelSwitch = new LoggingLevelSwitch();
 
+        private static InMemorySink _inMemorySink = new InMemorySink();
+
         public static void UpdateLoggingLevel(string newLogLevel)
         {
             _loggingLevelSwitch.MinimumLevel = newLogLevel.MapToSerilogLogLevel();
@@ -53,11 +56,9 @@ public static void Initialize()
                 .Enrich.With(new ThreadIdEnricher())
                 .Enrich.With(new ProcessIdEnricher())
                 .MinimumLevel.Information()
-                .ConfigureInMemoryLogSink()
+                .ConfigureInMemoryLogSink();
                 // TODO: implement event log sink
-                //.ConfigureEventLogSink()
-                // TODO: Remove console log sink when in-memory sink is implemented
-                .ConfigureConsoleSink();
+                //.ConfigureEventLogSink();
 
             // set the global Serilog logger to our startup logger instance, this gets replaced when ConfigureLogger() is called
             Serilog.Log.Logger = startupLoggerConfig.CreateLogger();
@@ -103,13 +104,12 @@ public static void ConfigureLogger(ILogConfig config)
 
         private static void EchoInMemoryLogsToConfiguredLogger(Serilog.ILogger configuredLogger)
         {
-            // TODO: copy logs from inMemory logger and emit them to Serilog.Log.Logger
-            // possible example:
-            //foreach (LogEvent logEvent in InMemorySink.Instance.LogEvents)
-            //{
-            //    configuredLogger.Write(logEvent.Level, logEvent.Exception, logEvent.MessageTemplate.Render(logEvent.Properties));
-            //}
-            //InMemorySink.Instance.Dispose();
+            foreach (var logEvent in _inMemorySink.LogEvents)
+            {
+                configuredLogger.Write(logEvent);
+            }
+
+            _inMemorySink.Dispose();
         }
 
         /// <summary>
@@ -133,9 +133,14 @@ private static void SetupLogLevel(ILogConfig config)
 
         private static LoggerConfiguration ConfigureInMemoryLogSink(this LoggerConfiguration loggerConfiguration)
         {
-            // TODO Configure the (yet-to-be-implemented) in-memory sink
-
-            return loggerConfiguration;
+            // formatter not needed since this will be pushed to other sinks for output.
+            return loggerConfiguration
+                .WriteTo.Logger(configuration =>
+                {
+                    configuration
+                        .ExcludeAuditLog()
+                        .WriteTo.Sink(_inMemorySink);
+                });
         }
 
         // TODO: Implement EventLog support, see commented package reference in Core.csproj

tests/Agent/UnitTests/Core.UnitTest/NewRelic.Agent.Core.FromLegacy/AgentLoggerTest.cs

@@ -11,6 +11,7 @@
 using log4net.Appender;
 using log4net.Core;
 using System.IO;
+using NewRelic.Agent.Core.Logging;
 
 namespace NewRelic.Agent.Core
 {
@@ -368,8 +369,6 @@ public static void Logging_sets_threadid_property_for_LogException()
             Assert.AreEqual(log4net.ThreadContext.Properties["threadid"], Thread.CurrentThread.ManagedThreadId);
         }
 
-
-
         static private ILogConfig GetLogConfig(string logLevel)
         {
             var xml = string.Format(