Deprecate Serilog Configuration

.gitignore

@@ -3,6 +3,9 @@
 ##
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
+# OS-specific files
+.DS_Store
+
 # User-specific files
 *.suo
 *.user

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/AdvancedLogger.cs

@@ -31,10 +31,13 @@ public class AdvancedLogger
         /// <summary>
         /// Gets or sets the Request logging mechanism.
         /// </summary>
+        [System.Obsolete("Use Logger with TraceLogger or a custom implementation.")]
         public RequestAdvancedLog RequestAdvancedLog { get; set; }
 
-
-
+        /// <summary>
+        /// Gets or sets the <see cref="IAdvancedLogger"/>.
+        /// </summary>
+        public IAdvancedLogger Logger { get; set; }
     }
 }
 

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/JsonFileConfigurationProvider.cs

@@ -97,6 +97,7 @@ public IppConfiguration GetConfiguration()
             ippConfig.AdvancedLogger = new AdvancedLogger
             {
 
+#pragma warning disable CS0618 // Type or member is obsolete
                 RequestAdvancedLog = new RequestAdvancedLog()
                 {
                     EnableSerilogRequestResponseLoggingForDebug = false,
@@ -105,6 +106,7 @@ public IppConfiguration GetConfiguration()
                     EnableSerilogRequestResponseLoggingForFile =  false,
                     ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
             };
 
             if (ippConfigurationSection == null)
@@ -115,11 +117,13 @@ public IppConfiguration GetConfiguration()
                 ippConfig.Logger = new Logger
                 {
                     CustomLogger = new TraceLogger(),
+#pragma warning disable CS0618 // Type or member is obsolete
                     RequestLog = new RequestLog
                     {
                         EnableRequestResponseLogging = false,
                         ServiceRequestLoggingLocation = System.IO.Path.GetTempPath()
                     }
+#pragma warning restore CS0618 // Type or member is obsolete
                 };
 
                 ippConfig.Message = new Message
@@ -160,6 +164,7 @@ public IppConfiguration GetConfiguration()
             }
 
             ippConfig.Logger = new Logger();
+#pragma warning disable CS0618 // Type or member is obsolete
             ippConfig.Logger.RequestLog = new RequestLog();
             ippConfig.Logger.RequestLog.EnableRequestResponseLogging = ippConfigurationSection.Logger.RequestLog.EnableRequestResponseLogging;
             if (string.IsNullOrEmpty(ippConfigurationSection.Logger.RequestLog.RequestResponseLoggingDirectory))
@@ -177,6 +182,7 @@ public IppConfiguration GetConfiguration()
 
                 ippConfig.Logger.RequestLog.ServiceRequestLoggingLocation = ippConfigurationSection.Logger.RequestLog.RequestResponseLoggingDirectory;
             }
+#pragma warning restore CS0618 // Type or member is obsolete
 
             if (!string.IsNullOrEmpty(ippConfigurationSection.Logger.CustomLogger.Name) && !string.IsNullOrEmpty(ippConfigurationSection.Logger.CustomLogger.Type) && ippConfigurationSection.Logger.CustomLogger.Enable)
             {
@@ -355,7 +361,8 @@ public IppConfiguration GetConfiguration()
 
             ippConfig.AdvancedLogger = new AdvancedLogger
             {
-
+
+#pragma warning disable CS0618 // Type or member is obsolete
                 RequestAdvancedLog = new RequestAdvancedLog()
                 {
                     EnableSerilogRequestResponseLoggingForDebug = false,
@@ -364,17 +371,20 @@ public IppConfiguration GetConfiguration()
                     EnableSerilogRequestResponseLoggingForFile = false,
                     ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
             };
 
 
             ippConfig.Logger = new Logger
             {
                 CustomLogger = new TraceLogger(),
+#pragma warning disable CS0618 // Type or member is obsolete
                 RequestLog = new RequestLog
                 {
                     EnableRequestResponseLogging = false,
                     ServiceRequestLoggingLocation = System.IO.Path.GetTempPath()
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
             };
 
             ippConfig.Message = new Message
@@ -481,6 +491,7 @@ public IppConfiguration GetConfiguration()
 
             #endregion
 
+#pragma warning disable CS0618 // Type or member is obsolete
             if (!string.IsNullOrEmpty(serilogLoggerSettingsFile["LogDirectory"]) && Convert.ToBoolean(serilogLoggerSettingsFile["EnableLogs"]) == true)
             {
 
@@ -517,6 +528,7 @@ public IppConfiguration GetConfiguration()
                 ippConfig.Logger.RequestLog.ServiceRequestLoggingLocation = loggerSettings["LogDirectory"];
 
             }
+#pragma warning disable CS0618 // Type or member is obsolete
 
             if (!string.IsNullOrEmpty(customLoggerSettings["Name"]) && !string.IsNullOrEmpty(customLoggerSettings["Type"]) && Convert.ToBoolean(customLoggerSettings["Enable"]) == true)
             {

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/Logger.cs

@@ -31,6 +31,7 @@ public class Logger
         /// <summary>
         /// Gets or sets the Request logging mechanism.
         /// </summary>
+        [System.Obsolete("Use a logging framework with CustomLogger.")]
         public RequestLog RequestLog { get; set; }
 
         /// <summary>

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/MemoryConfigurationProvider.cs

@@ -44,11 +44,13 @@ public MemoryConfigurationProvider(IppConfiguration cfg)
                 cfg.Logger = new Logger
                 {
                     CustomLogger = new TraceLogger(),
+#pragma warning disable CS0618 // Type or member is obsolete
                     RequestLog = new RequestLog
                     {
                         EnableRequestResponseLogging = false,
                         ServiceRequestLoggingLocation = System.IO.Path.GetTempPath()
                     }
+#pragma warning restore CS0618 // Type or member is obsolete
                 };
             }
 
@@ -57,6 +59,7 @@ public MemoryConfigurationProvider(IppConfiguration cfg)
                 cfg.AdvancedLogger = new AdvancedLogger
                 {
 
+#pragma warning disable CS0618 // Type or member is obsolete
                     RequestAdvancedLog = new RequestAdvancedLog()
                     {
                         EnableSerilogRequestResponseLoggingForDebug = false,
@@ -65,6 +68,7 @@ public MemoryConfigurationProvider(IppConfiguration cfg)
                         EnableSerilogRequestResponseLoggingForFile = false,
                         ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
                     }
+#pragma warning restore CS0618 // Type or member is obsolete
                 };
             }
 

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/RequestAdvancedLog.cs

@@ -30,6 +30,7 @@ namespace Intuit.Ipp.Core.Configuration
     /// <summary>
     /// Contains properties used to indicate whether request and response messages are to be logged.
     /// </summary>
+    [Obsolete("Serilog configuration for Advanced Logging deprecated.")]
     public class RequestAdvancedLog
     {
         /// <summary>

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Configuration/RequestLog.cs

@@ -29,6 +29,7 @@ namespace Intuit.Ipp.Core.Configuration
     /// <summary>
     /// Contains properties used to indicate whether request and response messages are to be logged.
     /// </summary>
+    [Obsolete("Direct file logging is deprecated. Use a logging framework.")]
     public class RequestLog
     {
         /// <summary>

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/CoreHelper.cs

@@ -39,9 +39,9 @@ public static class CoreHelper
 
 
         /// <summary>
-        /// Gets or sets Serilog Request Logging.
+        /// Gets or sets Advanced Request Logger.
         /// </summary>
-        internal static Diagnostics.AdvancedLogging AdvancedLogging;
+        internal static Diagnostics.IAdvancedLogger AdvancedLogging;
 
         /// <summary>
         /// Gets the serializer mechanism using the service context and the depending on the request and response.
@@ -158,6 +158,7 @@ public static ICompressor GetCompressor(ServiceContext serviceContext, bool isRe
         /// </summary>
         /// <param name="serviceContext">The serivce context object.</param>
         /// <returns>Returns value which specifies the request response logging mechanism.</returns>
+        [Obsolete("Use IppConfiguration.AdvangedLogger")]
         public static Rest.LogRequestsToDisk GetRequestLogging(ServiceContext serviceContext)
         {
             Rest.LogRequestsToDisk requestLogger;
@@ -179,13 +180,19 @@ public static Rest.LogRequestsToDisk GetRequestLogging(ServiceContext serviceCon
 
 
         /// <summary>
-        /// Gets the Request Response Logging mechanism for advanced logging using serilog.
+        /// Gets the Request Response Logging mechanism for advanced logging.
         /// </summary>
         /// <param name="serviceContext">The serivce context object.</param>
         /// <returns>Returns value which specifies the request response logging mechanism.</returns>
-        public static Diagnostics.AdvancedLogging GetAdvancedLogging(ServiceContext serviceContext)
+        public static Diagnostics.IAdvancedLogger GetAdvancedLogging(ServiceContext serviceContext)
         {
-            Diagnostics.AdvancedLogging requestLogger;
+            var requestLogger = serviceContext.IppConfiguration?.AdvancedLogger?.Logger;
+            if (requestLogger != null)
+            {
+                return requestLogger;
+            }
+
+#pragma warning disable CS0618 // Type or member is obsolete
             if (serviceContext.IppConfiguration != null &&
                 serviceContext.IppConfiguration.AdvancedLogger != null &&
                 serviceContext.IppConfiguration.AdvancedLogger.RequestAdvancedLog != null)
@@ -210,6 +217,9 @@ public static Diagnostics.AdvancedLogging GetAdvancedLogging(ServiceContext serv
             {
                 requestLogger = new Diagnostics.AdvancedLogging(enableSerilogRequestResponseLoggingForDebug: true, enableSerilogRequestResponseLoggingForTrace: true, enableSerilogRequestResponseLoggingForConsole: true, enableSerilogRequestResponseLoggingForFile: false, serviceRequestLoggingLocationForFile: null);
             }
+#pragma warning restore CS0618 // Type or member is obsolete
+
+            requestLogger.Log("Advanced Logging with Serilog is deprecated.");
 
             return requestLogger;
         }

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/RestCalls/AsyncRestHandler.cs

@@ -221,8 +221,11 @@ private void ExecAsyncRequestWithRetryPolicy(HttpWebRequest asyncRequest)
                                    CoreHelper.AdvancedLogging.Log(allHeaders.GetKey(i) + "-" + allHeaders[i]);
                                }
 
+#pragma warning disable CS0618 // Type or member is obsolete
                                // Log Request Body to a file
                                this.RequestLogging.LogPlatformRequests(" RequestUrl: " + request.RequestUri + ", Request Payload: " + this.requestBody, true);
+#pragma warning restore CS0618 // Type or member is obsolete
+
                                // Log Request Body to Serilog
                                CoreHelper.AdvancedLogging.Log(" Request Payload: " + this.requestBody);
 
@@ -448,8 +451,12 @@ private AsyncCallCompletedEventArgs CreateEventArgsForRequest(IAsyncResult async
                     response_intuit_tid_header = response.Headers[i];
                 }
             }
+
+#pragma warning disable CS0618 // Type or member is obsolete
             // Log the response to Disk.
             this.RequestLogging.LogPlatformRequests(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + resultString, false);
+#pragma warning restore CS0618 // Type or member is obsolete
+
             // Log response to Serilog
             CoreHelper.AdvancedLogging.Log(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + resultString);
 
@@ -577,8 +584,11 @@ private void GetRequestStreamCallback(IAsyncResult asynchronousResult)
         {
             HttpWebRequest request = (HttpWebRequest)asynchronousResult.AsyncState;
 
+#pragma warning disable CS0618 // Type or member is obsolete
             // Log Request Body to a file
             this.RequestLogging.LogPlatformRequests(" RequestUrl: " + request.RequestUri + ", Request Payload: " + this.requestBody, true);
+#pragma warning restore CS0618 // Type or member is obsolete
+
             // Log Request Body to Serilog
             CoreHelper.AdvancedLogging.Log(" RequestUrl: " + request.RequestUri + ", Request Payload: " + this.requestBody);
             UTF8Encoding encoding = new UTF8Encoding();

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/RestCalls/FaultHandler.cs

@@ -129,8 +129,11 @@ internal IdsException ParseResponseAndThrowException(WebException webException,
                             response_intuit_tid_header = errorResponse.Headers[i];
                         }
                     }
+
+#pragma warning disable CS0618 // Type or member is obsolete
                     //Log errorstring to disk
                     CoreHelper.GetRequestLogging(this.context).LogPlatformRequests(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + errorString, false);
+#pragma warning restore CS0618 // Type or member is obsolete
 
                     //Log errorstring to Serilog
                     CoreHelper.AdvancedLogging.Log(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + errorString);

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/RestCalls/RestHandler.cs

@@ -62,7 +62,11 @@ protected RestHandler(ServiceContext context)
             this.ResponseCompressor = CoreHelper.GetCompressor(this.serviceContext, false);
             this.RequestSerializer = CoreHelper.GetSerializer(this.serviceContext, true);
             this.responseSerializer = CoreHelper.GetSerializer(this.serviceContext, false);
+
+#pragma warning disable CS0618 // Type or member is obsolete
             this.RequestLogging = CoreHelper.GetRequestLogging(this.serviceContext);
+#pragma warning restore CS0618 // Type or member is obsolete
+
            // this.AdvancedLogging =  CoreHelper.GetAdvancedLogging(this.serviceContext);
         }
 
@@ -97,6 +101,7 @@ protected RestHandler()
         /// <summary>
         /// Gets or sets Request Logging.
         /// </summary>
+        [Obsolete("Use CoreHelper.AdvangedLogging")]
         internal LogRequestsToDisk RequestLogging { get; set; }
 
         ///// <summary>
@@ -264,9 +269,11 @@ public virtual System.Net.HttpWebRequest PrepareRequest(RequestParameters reques
                                 CoreHelper.AdvancedLogging.Log(allHeaders.GetKey(i) + "-" + allHeaders[i]);
                             }
 
-
+#pragma warning disable CS0618 // Type or member is obsolete
                             // Log Request Body to a file
                             this.RequestLogging.LogPlatformRequests(" RequestUrl: " + requestEndpoint + ", Request Payload:" + requestXML.ToString(), true);
+#pragma warning restore CS0618 // Type or member is obsolete
+
                             //Log to Serilog
                             CoreHelper.AdvancedLogging.Log( "Request Payload:" + requestXML.ToString());
 

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/RestCalls/SyncRestHandler.cs

@@ -379,7 +379,11 @@ private string ParseResponse(HttpWebResponse httpWebResponse)
                         response_intuit_tid_header = httpWebResponse.Headers[i];
                     }
                 }
+
+#pragma warning disable CS0618 // Type or member is obsolete
                 this.RequestLogging.LogPlatformRequests(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + response, false);
+#pragma warning restore CS0618 // Type or member is obsolete
+
                 //Log to Serilog
                 CoreHelper.AdvancedLogging.Log(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + response);
 

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Core/Retry/IntuitRetryPolicy.cs

@@ -409,9 +409,11 @@ public void ExecuteAction<TResult>(Action<AsyncCallback> beginAction, Func<IAsyn
                                                 }
                                             }
 
-
+#pragma warning disable CS0618 // Type or member is obsolete
                                             // Log the error string to disk.
                                             CoreHelper.GetRequestLogging(this.context).LogPlatformRequests(" Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + errorString, false);
+#pragma warning restore CS0618 // Type or member is obsolete
+
                                             //Log to Serilog
                                             CoreHelper.AdvancedLogging.Log("Response Intuit_Tid header: " + response_intuit_tid_header + ",Response Payload: " + errorString);
                                         }
@@ -627,8 +629,11 @@ private TResult ExecuteAction<TResult>(Func<TResult> func)
                                     }
                                 }
 
+#pragma warning disable CS0618 // Type or member is obsolete
                                 // Log the error string to disk.
                                 CoreHelper.GetRequestLogging(this.context).LogPlatformRequests(" Response Intuit_Tid header: " + response_intuit_tid_header + " Response Payload: " + errorString, false);
+#pragma warning restore CS0618 // Type or member is obsolete
+
                                 //Log to Serilog
                                 CoreHelper.AdvancedLogging.Log("Response Intuit_Tid header: " + response_intuit_tid_header + ", Response Payload: " + errorString);
 

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Diagnostics/AdvancedLogging.cs

@@ -34,23 +34,14 @@ namespace Intuit.Ipp.Diagnostics
     /// <summary>
     /// Contains properties used to indicate whether request and response messages are to be logged.
     /// </summary>
+    [Obsolete("Use TraceLogger or a custom implementation.")]
     public class AdvancedLogging : IAdvancedLogger
     {
         /// <summary>
         /// request logging location.
         /// </summary>
         private string serviceRequestLoggingLocationForFile;
 
-        /// <summary>
-        /// request Azure Document DB url.
-        /// </summary>
-        private Uri serviceRequestAzureDocumentDBUrl;
-
-        /// <summary>
-        /// request Azure Document DB Secure Key
-        /// </summary>
-        private string serviceRequestAzureDocumentDBSecureKey;
-
         /// <summary>
         /// request TTL-time to live for all logs 
         /// </summary>

IPPDotNetDevKitCSV3/Code/Intuit.Ipp.Diagnostics/Interface/IAdvancedLogger.cs

@@ -31,4 +31,23 @@ public interface IAdvancedLogger
         /// <param name="messageToWrite">The message to write.</param>
         void Log(string messageToWrite);
     }
+
+    /// <summary>
+    /// Null logger.
+    /// </summary>
+    public class NullAdvancedLogger : IAdvancedLogger
+    {
+        /// <summary>
+        /// Singleton instance of <see cref="NullAdvancedLogger"/>.
+        /// </summary>
+        public static readonly IAdvancedLogger Instance = new NullAdvancedLogger();
+
+        private NullAdvancedLogger()
+        {
+        }
+
+        void IAdvancedLogger.Log(string messageToWrite)
+        {
+        }
+    }
 }