Use syslog format for logging, add service request scopes to logs

src/AlarmCondition/Model/AreaState.cs

@@ -27,8 +27,6 @@
  * http://opcfoundation.org/License/MIT/1.00/
  * ======================================================================*/
 
-using System;
-using System.Collections.Generic;
 using Opc.Ua;
 
 namespace AlarmCondition

src/AlarmCondition/Model/ModelUtils.cs

@@ -27,11 +27,8 @@
  * http://opcfoundation.org/License/MIT/1.00/
  * ======================================================================*/
 
-using System;
-using System.Collections.Generic;
 using System.Text;
 using Opc.Ua;
-using Opc.Ua.Server;
 
 namespace AlarmCondition
 {

src/AlarmCondition/Model/Namespaces.cs

@@ -27,9 +27,6 @@
  * http://opcfoundation.org/License/MIT/1.00/
  * ======================================================================*/
 
-using System;
-using System.Collections.Generic;
-
 namespace AlarmCondition
 {
     /// <summary>

src/AlarmCondition/NodeHandle.cs

@@ -27,10 +27,7 @@
  * http://opcfoundation.org/License/MIT/1.00/
  * ======================================================================*/
 
-using System;
-using System.Text;
 using Opc.Ua;
-using Opc.Ua.Server;
 
 namespace AlarmCondition
 {

src/AlarmCondition/UnderlyingSystem/UnderlyingSystemAlarm.cs

@@ -28,7 +28,6 @@
  * ======================================================================*/
 
 using System;
-using System.Collections.Generic;
 using Opc.Ua;
 
 namespace AlarmCondition

src/AlarmCondition/UnderlyingSystem/UnderlyingSystemAlarmStates.cs

@@ -28,7 +28,6 @@
  * ======================================================================*/
 
 using System;
-using System.Collections.Generic;
 
 namespace AlarmCondition
 {

src/CliOptions.cs

@@ -1,5 +1,6 @@
-namespace OpcPlc;
+namespace OpcPlc;
 
+using Microsoft.Extensions.Logging;
 using Mono.Options;
 using Opc.Ua;
 using OpcPlc.Helpers;
@@ -31,11 +32,11 @@ public static Mono.Options.OptionSet InitCommandLineOptions()
                     }
                 }
             },
-            { "ll|loglevel=", "the loglevel to use (allowed: fatal, error, warn, info, debug, verbose).\nDefault: info", (string s) => {
-                    var logLevels = new List<string> {"fatal", "error", "warn", "info", "debug", "verbose"};
+            { "ll|loglevel=", "the loglevel to use (allowed: critical, warn, info, debug, trace Default: info", (string s) => {
+                    var logLevels = new List<string> {"critical", "error", "warn", "info", "debug", "trace"};
                     if (logLevels.Contains(s.ToLowerInvariant()))
                     {
-                        Program.LogLevel = s.ToLowerInvariant();
+                        Program.LogLevelCli = s.ToLowerInvariant();
                     }
                     else
                     {
@@ -232,7 +233,7 @@ public static void PrintUsage(Mono.Options.OptionSet options)
         using var stringWriter = new StringWriter(sb);
         options.WriteOptionDescriptions(stringWriter);
 
-        Program.Logger.Information(sb.ToString());
+        Program.Logger.LogInformation(sb.ToString());
     }
 
     /// <summary>
@@ -256,7 +257,7 @@ private static List<string> ParseListOfStrings(string list)
         else if (list.Contains(','))
         {
             strings = list.Split(',').ToList();
-            strings.ForEach(st => st.Trim());
+            strings.ForEach(st => st = st.Trim());
             strings = strings.Select(st => st.Trim()).ToList();
         }
         else

src/DeterministicAlarms/Configuration/Configuration.cs

@@ -1,41 +1,41 @@
-namespace OpcPlc.DeterministicAlarms.Configuration;
+namespace OpcPlc.DeterministicAlarms.Configuration;
 
 using System.Collections.Generic;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
 public class Configuration
-{
+{
+    static readonly JsonSerializerOptions _fromJsonOptions = new JsonSerializerOptions {
+        ReadCommentHandling = JsonCommentHandling.Skip,
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+        Converters =
+        {
+            new JsonStringEnumConverter(),
+        },
+    };
+
+    static readonly JsonSerializerOptions _toJsonOptions = new JsonSerializerOptions {
+        WriteIndented = true,
+        DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+        Converters =
+        {
+            new JsonStringEnumConverter()
+        }
+    };
+
     public List<Folder> Folders { get; set; }
 
     public Script Script { get; set; }
 
     public string ToJson()
     {
-        return JsonSerializer.Serialize(this,
-            new JsonSerializerOptions
-            {
-                WriteIndented = true,
-                DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
-                PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-                Converters =
-                {
-                        new JsonStringEnumConverter()
-                }
-            });
+        return JsonSerializer.Serialize(this, _toJsonOptions);
     }
 
     public static Configuration FromJson(string json)
     {
-        return JsonSerializer.Deserialize<Configuration>(json,
-            new JsonSerializerOptions
-            {
-                ReadCommentHandling = JsonCommentHandling.Skip,
-                PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-                Converters =
-                {
-                        new JsonStringEnumConverter(),
-                },
-            });
+        return JsonSerializer.Deserialize<Configuration>(json, _fromJsonOptions);
     }
 }

src/DeterministicAlarms/DeterministicAlarmsNodeManager.cs

@@ -9,6 +9,7 @@
 using System.Collections.Generic;
 using System.IO;
 using static OpcPlc.Program;
+using Microsoft.Extensions.Logging;
 
 public class DeterministicAlarmsNodeManager : CustomNodeManager2
 {
@@ -49,7 +50,7 @@ public DeterministicAlarmsNodeManager(IServerInternal server, ApplicationConfigu
         }
         catch (Exception ex)
         {
-            Logger.Error(ex, "Cannot read or decode deterministic alarm script file");
+            Logger.LogError(ex, "Cannot read or decode deterministic alarm script file");
         }
     }
 
@@ -115,12 +116,12 @@ private void ReplayScriptStart(Configuration.Configuration scriptConfiguration)
         try
         {
             VerifyScriptConfiguration(scriptConfiguration);
-            Logger.Information("Script starts executing");
+            Logger.LogInformation("Script starts executing");
             var scriptEngine = new ScriptEngine(scriptConfiguration.Script, OnScriptStepAvailable, _timeService);
         }
         catch (ScriptException ex)
         {
-            Logger.Error($"Script Engine Exception '{ex.Message}'\nSCRIPT WILL NOT START");
+            Logger.LogError($"Script Engine Exception '{ex.Message}'\nSCRIPT WILL NOT START");
             throw;
         }
     }
@@ -134,7 +135,7 @@ private void OnScriptStepAvailable(Step step, long loopNumber)
     {
         if (step == null)
         {
-            Logger.Information("SCRIPT ENDED");
+            Logger.LogInformation("SCRIPT ENDED");
         }
         else
         {
@@ -199,16 +200,16 @@ private void PrintScriptStep(Step step, long loopNumber)
     {
         if (step.Event != null)
         {
-            Logger.Information($"({loopNumber}) -\t{step.Event.AlarmId}\t{step.Event.Reason}");
+            Logger.LogInformation($"({loopNumber}) -\t{step.Event.AlarmId}\t{step.Event.Reason}");
             foreach (var sc in step.Event.StateChanges)
             {
-                Logger.Information($"\t\t{sc.StateType} - {sc.State}");
+                Logger.LogInformation($"\t\t{sc.StateType} - {sc.State}");
             }
         }
 
         if (step.SleepInSeconds > 0)
         {
-            Logger.Information($"({loopNumber}) -\tSleep: {step.SleepInSeconds}");
+            Logger.LogInformation($"({loopNumber}) -\tSleep: {step.SleepInSeconds}");
         }
     }
 

src/Helpers/PnJsonHelper.cs

@@ -1,7 +1,7 @@
 namespace OpcPlc.Helpers;
 
+using Microsoft.Extensions.Logging;
 using OpcPlc.PluginNodes.Models;
-using Serilog;
 using System;
 using System.Collections.Immutable;
 using System.IO;
@@ -53,7 +53,7 @@ public static async Task PrintPublisherConfigJsonAsync(string pnJsonFileName, st
         sb.AppendLine("]");
 
         string pnJson = sb.ToString();
-        logger.Information("OPC Publisher configuration file: {pnJsonFile}", $"{pnJsonFileName}{pnJson}");
+        logger.LogInformation("OPC Publisher configuration file: {pnJsonFile}", $"{pnJsonFileName}{pnJson}");
 
         await File.WriteAllTextAsync(pnJsonFileName, pnJson.Trim()).ConfigureAwait(false);
     }

src/Logging/LoggingProvider.cs

@@ -0,0 +1,32 @@
+// ------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation.  All rights reserved.
+//  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// ------------------------------------------------------------
+
+namespace OpcPlc.Logging;
+
+using Microsoft.Extensions.Logging;
+using System;
+
+/// <summary>
+/// Provides utility for creating logger factory.
+/// </summary>
+public static class LoggingProvider
+{
+    /// <summary>
+    /// Create ILoggerFactory object with default configuration.
+    /// </summary>
+    public static ILoggerFactory CreateDefaultLoggerFactory(LogLevel level)
+    {
+        var loggerFactory = LoggerFactory.Create(builder =>
+        {
+            builder.AddConsole(options => options.FormatterName = nameof(SyslogFormatter))
+            .SetMinimumLevel(level)
+            .AddConsoleFormatter<
+                SyslogFormatter,
+                SyslogFormatterOptions>();
+        });
+
+        return loggerFactory;
+    }
+}