Update naming and move to a Logging namespace

Author: EmandM

com.unity.netcode.gameobjects/Editor/NetworkManagerEditor.cs

@@ -3,6 +3,7 @@
 using System.IO;
 using System.Linq;
 using Unity.Netcode.Editor.Configuration;
+using Unity.Netcode.Logging;
 using UnityEditor;
 using UnityEngine;
 #if UNITY_6000_5_OR_NEWER
@@ -298,7 +299,7 @@ private void DisplayNetworkManagerProperties()
 #else
                         string path = Path.Combine(directory, $"NetworkPrefabs-{m_NetworkManager.GetInstanceID()}.asset");
 #endif
-                        m_NetworkManager.Log.Info(new Context(LogLevel.Normal, "Saving migrated Network Prefabs List").With("Path", path));
+                        m_NetworkManager.Log.Info(new Context(LogLevel.Normal, "Saving migrated Network Prefabs List").AddInfo("Path", path));
                         AssetDatabase.CreateAsset(networkPrefabs, path);
                         EditorUtility.SetDirty(m_NetworkManager);
                     }

com.unity.netcode.gameobjects/Editor/NetworkManagerHelper.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Unity.Netcode.Editor.Configuration;
+using Unity.Netcode.Logging;
 using UnityEditor;
 using UnityEngine;
 using UnityEngine.SceneManagement;

com.unity.netcode.gameobjects/Runtime/Core/NetworkManager.cs

@@ -3,6 +3,7 @@
 using Unity.Collections;
 using System.Linq;
 using Unity.Netcode.Components;
+using Unity.Netcode.Logging;
 using Unity.Netcode.Runtime;
 using UnityEngine;
 #if UNITY_EDITOR
@@ -73,7 +74,7 @@ internal static void LogSerializedTypeNotOptimized<T>()
             if (!s_SerializedType.Contains(type))
             {
                 s_SerializedType.Add(type);
-                NetworkLog.LogWarning(new Context(LogLevel.Developer, "Serialized type has not been optimized for use with Distributed Authority!").With(type.Name));
+                NetworkLog.LogWarning(new Context(LogLevel.Developer, "Serialized type has not been optimized for use with Distributed Authority!").AddTag(type.Name));
             }
         }
 #endif
@@ -242,12 +243,12 @@ internal void PromoteSessionOwner(ulong clientId)
             if (!DistributedAuthorityMode)
             {
                 // [Netcode] [PromoteSessionOwner][SceneManagement][NotDA] Invoking promote session owner while not in distributed authority mode!
-                Log.ErrorServer(new Context(LogLevel.Error, "Invoking promote session owner while not in distributed authority mode!").With("SceneManagement").With("NotDA"));
+                Log.ErrorServer(new Context(LogLevel.Error, "Invoking promote session owner while not in distributed authority mode!").AddTag("SceneManagement").AddTag("NotDA"));
                 return;
             }
             if (!DAHost)
             {
-                Log.ErrorServer(new Context(LogLevel.Error, "Client is attempting to promote another client as the session owner!").With("SceneManagement").With("NotDAHost"));
+                Log.ErrorServer(new Context(LogLevel.Error, "Client is attempting to promote another client as the session owner!").AddTag("SceneManagement").AddTag("NotDAHost"));
                 return;
             }
             SetSessionOwner(clientId);
@@ -315,7 +316,7 @@ private void UpdateTopology()
             if (transportTopology != NetworkConfig.NetworkTopology)
             {
                 Log.ErrorServer(new Context(LogLevel.Error, "Transport detected an issue with the topology usage or setting! Disconnecting from session.")
-                    .With("Topology Mismatch").With(transportTopology, transportTopology.GetType().Name).With("NetworkManager.NetworkConfig", NetworkConfig.NetworkTopology));
+                    .AddTag("Topology Mismatch").AddInfo(transportTopology, transportTopology.GetType().Name).AddInfo("NetworkManager.NetworkConfig", NetworkConfig.NetworkTopology));
                 Shutdown(true);
             }
             else
@@ -1054,10 +1055,10 @@ private void Awake()
         {
             if (Log == null)
             {
-                Log = new ContextualLogger(this, gameObject);
+                Log = new ContextualLogger(this, this);
             }
 
-            NetworkConfig?.InitializePrefabs();
+            NetworkConfig?.InitializePrefabs(Log);
 
             UnityEngine.SceneManagement.SceneManager.sceneUnloaded += OnSceneUnloaded;
 #if UNITY_EDITOR
@@ -1263,7 +1264,7 @@ internal void Initialize(bool server)
             BehaviourUpdater = new NetworkBehaviourUpdater();
             BehaviourUpdater.Initialize(this);
 
-            NetworkConfig.InitializePrefabs();
+            NetworkConfig.InitializePrefabs(Log);
             PrefabHandler.RegisterPlayerPrefab();
 #if UNITY_EDITOR
             BeginNetworkSession();
@@ -1285,7 +1286,7 @@ private bool CanStart(StartType type)
         {
             if (IsListening)
             {
-                Log.Warning(new Context(LogLevel.Normal, "Can't start while listening").With("Start", type));
+                Log.Warning(new Context(LogLevel.Normal, "Can't start while listening").AddInfo("Start", type));
                 return false;
             }
 
@@ -1295,15 +1296,15 @@ private bool CanStart(StartType type)
             {
                 if (ConnectionApprovalCallback == null)
                 {
-                    Log.Warning(new Context(LogLevel.Normal, $"No {nameof(ConnectionApprovalCallback)} defined. Connection approval will timeout").With("Start", type));
+                    Log.Warning(new Context(LogLevel.Normal, $"No {nameof(ConnectionApprovalCallback)} defined. Connection approval will timeout").AddInfo("Start", type));
                 }
             }
 
             if (ConnectionApprovalCallback != null)
             {
                 if (!NetworkConfig.ConnectionApproval)
                 {
-                    Log.Warning(new Context(LogLevel.Normal, $"{nameof(ConnectionApprovalCallback)} is defined but {nameof(NetworkConfig.ConnectionApproval)} is disabled. In order to use ConnectionApproval it has to be explicitly enabled").With("Start", type));
+                    Log.Warning(new Context(LogLevel.Normal, $"{nameof(ConnectionApprovalCallback)} is defined but {nameof(NetworkConfig.ConnectionApproval)} is disabled. In order to use ConnectionApproval it has to be explicitly enabled").AddInfo("Start", type));
                 }
             }
 
@@ -1725,7 +1726,7 @@ private void OnApplicationQuit()
 #if UNITY_EDITOR
             if (Singleton != null)
             {
-                Log.Warning(new Context(LogLevel.Error, $"Singleton is not null after invoking OnDestroy. Do you have more than one {nameof(NetworkManager)} instance in the DDOL scene?").With("SingletonInstance", Singleton.name));
+                Log.Warning(new Context(LogLevel.Error, $"Singleton is not null after invoking OnDestroy. Do you have more than one {nameof(NetworkManager)} instance in the DDOL scene?").AddInfo("SingletonInstance", Singleton.name));
             }
 #endif
         }
@@ -1824,7 +1825,7 @@ internal void OnValidate()
 
             if (Log == null)
             {
-                Log = new ContextualLogger(this, gameObject);
+                Log = new ContextualLogger(this, this);
             }
 
             // Do a validation pass on NetworkConfig properties
@@ -1835,44 +1836,6 @@ internal void OnValidate()
                 Log.Warning(new Context(LogLevel.Normal, $"{nameof(NetworkManager)} cannot be a {nameof(NetworkObject)}."));
             }
 
-            var activeScene = UnityEngine.SceneManagement.SceneManager.GetActiveScene();
-
-            // If the scene is not dirty or the asset database is currently updating then we can skip updating the NetworkPrefab information
-            if (!activeScene.isDirty || EditorApplication.isUpdating)
-            {
-                return;
-            }
-
-            // During OnValidate we will always clear out NetworkPrefabOverrideLinks and rebuild it
-            NetworkConfig.Prefabs.NetworkPrefabOverrideLinks.Clear();
-
-            var prefabs = NetworkConfig.Prefabs.Prefabs;
-            // Check network prefabs and assign to dictionary for quick look up
-            foreach (var networkPrefab in prefabs)
-            {
-                var networkPrefabGo = networkPrefab?.Prefab;
-                if (networkPrefabGo == null)
-                {
-                    continue;
-                }
-
-                var networkObject = networkPrefabGo.GetComponent<NetworkObject>();
-                if (networkObject == null)
-                {
-                    Log.Warning(new Context(LogLevel.Normal, $"Cannot register prefab to {nameof(NetworkManager)}, missing a {nameof(NetworkObject)} component at its root").ForNetworkPrefab(networkPrefab));
-                    continue;
-                }
-
-                {
-                    var childNetworkObjects = new List<NetworkObject>();
-                    networkPrefabGo.GetComponentsInChildren(true, childNetworkObjects);
-                    if (childNetworkObjects.Count > 1) // total count = 1 root NetworkObject + n child NetworkObjects
-                    {
-                        Log.Warning(new Context(LogLevel.Normal, $"Prefab has child {nameof(NetworkObject)}(s) but they will not be spawned across the network (unsupported {nameof(NetworkPrefab)} setup)").ForNetworkPrefab(networkPrefab));
-                    }
-                }
-            }
-
             try
             {
                 OnValidateComponent();

com.unity.netcode.gameobjects/Runtime/Logging/ContextualLogger.cs

@@ -2,37 +2,55 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
-using System.Text;
 using UnityEngine;
 using Debug = UnityEngine.Debug;
 using LogType = UnityEngine.LogType;
+using Object = UnityEngine.Object;
 
-namespace Unity.Netcode
+namespace Unity.Netcode.Logging
 {
+    /// <summary>
+    /// Configurable structured logger.
+    /// Each logger instance collects system-wide context
+    /// (e.g. which <see cref="Object"/> to attribute the logs to; or the <see cref="NetworkManager"/> relating to this object)
+    /// Each log is made with a <see cref="Context"/> object that collects the local context of this individual log line
+    /// The contextual logger will combine the system-wide context and the local context into one structured log message.
+    /// </summary>
     internal class ContextualLogger
     {
         private const string k_NetcodeHeader = "[Netcode] ";
-        private bool m_UseCompatibilityMode;
-        private readonly GameObject m_GameObject;
-        private readonly ContextBuilder m_Builder = new();
+        private readonly bool m_UseCompatibilityMode;
+        private readonly Object m_Object;
+        private readonly LogBuilder m_Builder = new();
 
         private LogContextNetworkManager m_ManagerContext;
         private readonly GenericContext m_LoggerContext;
 
         private const string k_CompilationCondition = "UNITY_ASSERTIONS";
 
+        /// <summary>
+        /// Creates a minimally configured contextual logger
+        /// </summary>
+        /// <param name="useCompatibilityMode">Suppresses adding </param>
         public ContextualLogger(bool useCompatibilityMode = false)
         {
             m_UseCompatibilityMode = useCompatibilityMode;
             m_ManagerContext = new LogContextNetworkManager(true);
-            m_GameObject = null;
+            m_Object = null;
             m_LoggerContext = GenericContext.Create();
         }
 
-        public ContextualLogger([NotNull] NetworkManager networkManager, GameObject gameObject)
+        public ContextualLogger(Object inspectorObject)
+        {
+            m_ManagerContext = new LogContextNetworkManager(true);
+            m_Object = inspectorObject;
+            m_LoggerContext = GenericContext.Create();
+        }
+
+        public ContextualLogger(Object inspectorObject, [NotNull] NetworkManager networkManager)
         {
             m_ManagerContext = new LogContextNetworkManager(networkManager);
-            m_GameObject = gameObject;
+            m_Object = inspectorObject;
             m_LoggerContext = GenericContext.Create();
         }
 
@@ -44,24 +62,29 @@ internal void UpdateNetworkManagerContext(NetworkManager manager)
         }
 
         [Conditional(k_CompilationCondition)]
-        internal void PushContext(string key, object value)
+        internal void AddInfo(string key, object value)
         {
             m_LoggerContext.StoreInfo(key, value);
         }
 
-        [Conditional(k_CompilationCondition)]
-        internal void PushContext(string key)
+        /// <summary>
+        /// Adds info onto a logger that will be removed once the <see cref="DisposableContext"/> is disposed
+        /// </summary>
+        /// <param name="key">Key to log</param>
+        /// <param name="value">Value to log</param>
+        /// <returns>Object to dispose when context is no longer valid</returns>
+        internal DisposableContext AddDisposableInfo(string key, object value)
         {
-            m_LoggerContext.StoreContext(key);
+            m_LoggerContext.StoreInfo(key, value);
+            return new DisposableContext(this, key);
         }
 
         [Conditional(k_CompilationCondition)]
-        internal void PopContext(string key)
+        internal void RemoveInfo(string key)
         {
             m_LoggerContext.ClearInfo(key);
         }
 
-
         [HideInCallstack]
         [Conditional(k_CompilationCondition)]
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -93,7 +116,7 @@ public void CaptureFunctionCall([CallerMemberName] string memberName = "")
         [HideInCallstack]
         public void Exception(Exception exception)
         {
-            Debug.unityLogger.LogException(exception, m_GameObject);
+            Debug.unityLogger.LogException(exception, m_Object);
         }
 
         [HideInCallstack]
@@ -106,7 +129,7 @@ private void Log(LogType logType, Context context)
             }
 
             var message = BuildLog(context);
-            Debug.unityLogger.Log(logType, (object)message, context.GameObjectOverride ?? m_GameObject);
+            Debug.unityLogger.Log(logType, (object)message, context.RelevantObjectOverride ?? m_Object);
         }
 
         [HideInCallstack]
@@ -119,9 +142,9 @@ private void LogServer(LogType logType, Context context)
             }
 
             var message = BuildLog(context);
-            Debug.unityLogger.Log(logType, (object)message, context.GameObjectOverride ?? m_GameObject);
+            Debug.unityLogger.Log(logType, (object)message, context.RelevantObjectOverride ?? m_Object);
 
-            m_ManagerContext.TrySendMessage(logType, message);
+            m_ManagerContext.TrySendMessage(logType, message.Remove(0, k_NetcodeHeader.Length));
         }
 
         private string BuildLog(Context context)
@@ -132,7 +155,7 @@ private string BuildLog(Context context)
             m_Builder.Append(k_NetcodeHeader);
 
             if (m_UseCompatibilityMode)
-            {
+            { ;
                 m_Builder.Append(context.Message);
             }
             else
@@ -147,38 +170,25 @@ private string BuildLog(Context context)
 
             return m_Builder.Build();
         }
-    }
-
-    internal class ContextBuilder
-    {
-        private readonly StringBuilder m_Builder = new();
-        private const string k_OpenBracket = "[";
-        private const string k_CloseBracket = "]";
-        private const string k_Separator = ":";
 
-        public void Reset()
+        /// <summary>
+        /// Removes the configured context from the logger when this object is disposed.
+        /// </summary>
+        public readonly struct DisposableContext: IDisposable
         {
-            m_Builder.Clear();
-        }
+            private readonly ContextualLogger m_Logger;
+            private readonly string m_ToClear;
 
-        public void AppendContext(string context)
-        {
-            m_Builder.Append(k_OpenBracket);
-            m_Builder.Append(context);
-            m_Builder.Append(k_CloseBracket);
-        }
+            internal DisposableContext(ContextualLogger logger, string toClear)
+            {
+                m_Logger = logger;
+                m_ToClear = toClear;
+            }
 
-        public void AppendContext(object key, object value)
-        {
-            m_Builder.Append(k_OpenBracket);
-            m_Builder.Append(key);
-            m_Builder.Append(k_Separator);
-            m_Builder.Append(value);
-            m_Builder.Append(k_CloseBracket);
+            public void Dispose()
+            {
+                m_Logger.RemoveInfo(m_ToClear);
+            }
         }
-
-        public void Append(string value) => m_Builder.Append(value);
-
-        public string Build() => m_Builder.ToString();
     }
 }