Skip to content

Commit 814af50

Browse files
committed
Mark Serilog-related classes and properties [Obsolete]
1 parent 9df0a94 commit 814af50

File tree

6 files changed

+16
-1
lines changed

6 files changed

+16
-1
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public class AdvancedLogger
3131
/// <summary>
3232
/// Gets or sets the Request logging mechanism.
3333
/// </summary>
34+
[System.Obsolete("Use Logger with TraceLogger or a custom implementation.")]
3435
public RequestAdvancedLog RequestAdvancedLog { get; set; }
3536

3637
/// <summary>

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ public IppConfiguration GetConfiguration()
9797
ippConfig.AdvancedLogger = new AdvancedLogger
9898
{
9999

100+
#pragma warning disable CS0618 // Type or member is obsolete
100101
RequestAdvancedLog = new RequestAdvancedLog()
101102
{
102103
EnableSerilogRequestResponseLoggingForDebug = false,
@@ -105,6 +106,7 @@ public IppConfiguration GetConfiguration()
105106
EnableSerilogRequestResponseLoggingForFile = false,
106107
ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
107108
}
109+
#pragma warning restore CS0618 // Type or member is obsolete
108110
};
109111

110112
if (ippConfigurationSection == null)
@@ -355,7 +357,8 @@ public IppConfiguration GetConfiguration()
355357

356358
ippConfig.AdvancedLogger = new AdvancedLogger
357359
{
358-
360+
361+
#pragma warning disable CS0618 // Type or member is obsolete
359362
RequestAdvancedLog = new RequestAdvancedLog()
360363
{
361364
EnableSerilogRequestResponseLoggingForDebug = false,
@@ -364,6 +367,7 @@ public IppConfiguration GetConfiguration()
364367
EnableSerilogRequestResponseLoggingForFile = false,
365368
ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
366369
}
370+
#pragma warning restore CS0618 // Type or member is obsolete
367371
};
368372

369373

@@ -481,6 +485,7 @@ public IppConfiguration GetConfiguration()
481485

482486
#endregion
483487

488+
#pragma warning disable CS0618 // Type or member is obsolete
484489
if (!string.IsNullOrEmpty(serilogLoggerSettingsFile["LogDirectory"]) && Convert.ToBoolean(serilogLoggerSettingsFile["EnableLogs"]) == true)
485490
{
486491

@@ -499,6 +504,7 @@ public IppConfiguration GetConfiguration()
499504
ippConfig.AdvancedLogger.RequestAdvancedLog.ServiceRequestLoggingLocationForFile = serilogLoggerSettingsFile["LogDirectory"];
500505

501506
}
507+
#pragma warning restore CS0618 // Type or member is obsolete
502508

503509
//old logger
504510
if (!string.IsNullOrEmpty(loggerSettings["LogDirectory"]) && Convert.ToBoolean(loggerSettings["EnableLogs"]) == true)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ public MemoryConfigurationProvider(IppConfiguration cfg)
5757
cfg.AdvancedLogger = new AdvancedLogger
5858
{
5959

60+
#pragma warning disable CS0618 // Type or member is obsolete
6061
RequestAdvancedLog = new RequestAdvancedLog()
6162
{
6263
EnableSerilogRequestResponseLoggingForDebug = false,
@@ -65,6 +66,7 @@ public MemoryConfigurationProvider(IppConfiguration cfg)
6566
EnableSerilogRequestResponseLoggingForFile = false,
6667
ServiceRequestLoggingLocationForFile = System.IO.Path.GetTempPath()
6768
}
69+
#pragma warning restore CS0618 // Type or member is obsolete
6870
};
6971
}
7072

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ namespace Intuit.Ipp.Core.Configuration
3030
/// <summary>
3131
/// Contains properties used to indicate whether request and response messages are to be logged.
3232
/// </summary>
33+
[Obsolete("Serilog configuration for Advanced Logging deprecated.")]
3334
public class RequestAdvancedLog
3435
{
3536
/// <summary>

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ public static Diagnostics.IAdvancedLogger GetAdvancedLogging(ServiceContext serv
191191
return requestLogger;
192192
}
193193

194+
#pragma warning disable CS0618 // Type or member is obsolete
194195
if (serviceContext.IppConfiguration != null &&
195196
serviceContext.IppConfiguration.AdvancedLogger != null &&
196197
serviceContext.IppConfiguration.AdvancedLogger.RequestAdvancedLog != null)
@@ -215,6 +216,9 @@ public static Diagnostics.IAdvancedLogger GetAdvancedLogging(ServiceContext serv
215216
{
216217
requestLogger = new Diagnostics.AdvancedLogging(enableSerilogRequestResponseLoggingForDebug: true, enableSerilogRequestResponseLoggingForTrace: true, enableSerilogRequestResponseLoggingForConsole: true, enableSerilogRequestResponseLoggingForFile: false, serviceRequestLoggingLocationForFile: null);
217218
}
219+
#pragma warning restore CS0618 // Type or member is obsolete
220+
221+
requestLogger.Log("Advanced Logging with Serilog is deprecated.");
218222

219223
return requestLogger;
220224
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ namespace Intuit.Ipp.Diagnostics
3434
/// <summary>
3535
/// Contains properties used to indicate whether request and response messages are to be logged.
3636
/// </summary>
37+
[Obsolete("Use TraceLogger or a custom implementation.")]
3738
public class AdvancedLogging : IAdvancedLogger
3839
{
3940
/// <summary>

0 commit comments

Comments
 (0)