Implement metrics for network variable deltas

com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs

@@ -17,6 +17,7 @@
 using MLAPI.Spawning;
 using MLAPI.Transports;
 using Unity.Profiling;
+using Debug = UnityEngine.Debug;
 
 namespace MLAPI
 {
@@ -444,6 +445,7 @@ internal void InitializeVariables()
                     }
 
                     instance.SetNetworkBehaviour(this);
+                    instance.Name = sortedFields[i].Name;
                     NetworkVariableFields.Add(instance);
                 }
             }
@@ -649,6 +651,7 @@ private void NetworkVariableUpdate(ulong clientId, int behaviourIndex)
                                 if (shouldWrite)
                                 {
                                     writtenAny = true;
+                                    var deltaBuffer = 0L;
 
                                     if (NetworkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
                                     {
@@ -659,6 +662,7 @@ private void NetworkVariableUpdate(ulong clientId, int behaviourIndex)
 
                                             writer.WriteUInt16Packed((ushort)varBuffer.Length);
                                             buffer.CopyFrom(varBuffer);
+                                            deltaBuffer = varBuffer.Length;
                                         }
                                     }
                                     else
@@ -671,6 +675,8 @@ private void NetworkVariableUpdate(ulong clientId, int behaviourIndex)
                                         m_NetworkVariableIndexesToResetSet.Add(k);
                                         m_NetworkVariableIndexesToReset.Add(k);
                                     }
+
+                                    NetworkManager.NetworkMetrics.TrackNetworkVariableDeltaSent(clientId, NetworkObjectId, name, NetworkVariableFields[k].Name, (ulong)deltaBuffer);
                                 }
                             }
 
@@ -759,9 +765,8 @@ internal static void HandleNetworkVariableDeltas(List<INetworkVariable> networkV
 
                     networkVariableList[i].ReadDelta(stream, networkManager.IsServer);
                     PerformanceDataManager.Increment(ProfilerConstants.NetworkVarDeltas);
-
-
                     ProfilerStatManager.NetworkVarsRcvd.Record();
+                    networkManager.NetworkMetrics.TrackNetworkVariableDeltaReceived(clientId, logInstance.NetworkObjectId, logInstance.name, networkVariableList[i].Name, (ulong)stream.Length);
 
                     if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)
                     {
@@ -847,7 +852,6 @@ internal static void HandleNetworkVariableUpdate(List<INetworkVariable> networkV
 
                     networkVariableList[i].ReadField(stream);
                     PerformanceDataManager.Increment(ProfilerConstants.NetworkVarUpdates);
-
                     ProfilerStatManager.NetworkVarsRcvd.Record();
 
                     if (networkManager.NetworkConfig.EnsureNetworkVariableLengthSafety)

com.unity.multiplayer.mlapi/Runtime/Metrics/INetworkMetrics.cs

@@ -18,6 +18,10 @@ public interface INetworkMetrics
 
         void TrackUnnamedMessageReceived(ulong senderClientId, ulong bytesCount);
 
+        void TrackNetworkVariableDeltaSent(ulong receiverClientId, ulong networkObjectId, string gameObjectName,string variableName, ulong bytesCount);
+
+        void TrackNetworkVariableDeltaReceived(ulong senderClientId, ulong networkObjectId, string gameObjectName,string variableName, ulong bytesCount);
+
         void DispatchFrame();
     }
 }

com.unity.multiplayer.mlapi/Runtime/Metrics/NetworkMetrics.cs

@@ -17,6 +17,9 @@ public class NetworkMetrics : INetworkMetrics
         readonly EventMetric<UnnamedMessageEvent> m_UnnamedMessageSentEvent = new EventMetric<UnnamedMessageEvent>(MetricNames.UnnamedMessageSent);
         readonly EventMetric<UnnamedMessageEvent> m_UnnamedMessageReceivedEvent = new EventMetric<UnnamedMessageEvent>(MetricNames.UnnamedMessageReceived);
 
+        readonly EventMetric<NetworkVariableEvent> m_NetworkVariableDeltaSentEvent = new EventMetric<NetworkVariableEvent>(MetricNames.NetworkVariableDeltaSent);
+        readonly EventMetric<NetworkVariableEvent> m_NetworkVariableDeltaReceivedEvent = new EventMetric<NetworkVariableEvent>(MetricNames.NetworkVariableDeltaReceived);
+
         private Dictionary<ulong, NetworkObjectIdentifier> m_NetworkGameObjects = new Dictionary<ulong, NetworkObjectIdentifier>();
 
         public NetworkMetrics(NetworkManager networkManager)
@@ -25,6 +28,7 @@ public NetworkMetrics(NetworkManager networkManager)
             Dispatcher = new MetricDispatcherBuilder()
                 .WithMetricEvents(m_NamedMessageSentEvent, m_NamedMessageReceivedEvent)
                 .WithMetricEvents(m_UnnamedMessageSentEvent, m_UnnamedMessageReceivedEvent)
+                .WithMetricEvents(m_NetworkVariableDeltaSentEvent, m_NetworkVariableDeltaReceivedEvent)
                 .Build();
 
             Dispatcher.RegisterObserver(MLAPIObserver.Observer);
@@ -75,11 +79,28 @@ public void TrackUnnamedMessageReceived(ulong senderClientId, ulong bytesCount)
         {
             m_UnnamedMessageReceivedEvent.Mark(new UnnamedMessageEvent(new ConnectionInfo(senderClientId), bytesCount));
         }
+
+        public void TrackNetworkVariableDeltaSent(ulong receiverClientId, ulong networkObjectId, string gameObjectName, string variableName, ulong bytesCount)
+        {
+            variableName = PrettyPrintVariableName(variableName);
+            m_NetworkVariableDeltaSentEvent.Mark(new NetworkVariableEvent(new ConnectionInfo(receiverClientId), new NetworkObjectIdentifier(gameObjectName, networkObjectId), variableName, bytesCount));
+        }
+
+        public void TrackNetworkVariableDeltaReceived(ulong senderClientId, ulong networkObjectId, string gameObjectName, string variableName, ulong bytesCount)
+        {
+            variableName = PrettyPrintVariableName(variableName);
+            m_NetworkVariableDeltaReceivedEvent.Mark(new NetworkVariableEvent(new ConnectionInfo(senderClientId), new NetworkObjectIdentifier(gameObjectName, networkObjectId), variableName, bytesCount));
+        }
 
         public void DispatchFrame()
         {
             Dispatcher.Dispatch();
         }
+
+        private static string PrettyPrintVariableName(string variableName)
+        {
+            return variableName.Replace("<", string.Empty).Replace(">k__BackingField", string.Empty);
+        }
     }
 
     public class MLAPIObserver

com.unity.multiplayer.mlapi/Runtime/Metrics/NullNetworkMetrics.cs

@@ -32,6 +32,14 @@ public void TrackUnnamedMessageReceived(ulong senderClientId, ulong bytesCount)
         {
         }
 
+        public void TrackNetworkVariableDeltaSent(ulong receiverClientId, ulong networkObjectId, string gameObjectName, string variableName, ulong bytesCount)
+        {
+        }
+
+        public void TrackNetworkVariableDeltaReceived(ulong senderClientId, ulong networkObjectId, string gameObjectName, string variableName, ulong bytesCount)
+        {
+        }
+
         public void DispatchFrame()
         {
         }

com.unity.multiplayer.mlapi/Runtime/NetworkVariable/Collections/NetworkDictionary.cs

@@ -74,6 +74,8 @@ public NetworkDictionary(IDictionary<TKey, TValue> value)
             m_Dictionary = value;
         }
 
+        public string Name { get; set; }
+
         /// <inheritdoc />
         public void ResetDirty()
         {

com.unity.multiplayer.mlapi/Runtime/NetworkVariable/Collections/NetworkList.cs

@@ -72,6 +72,8 @@ public NetworkList(IList<T> value)
             m_List = value;
         }
 
+        public string Name { get; set; }
+
         /// <inheritdoc />
         public void ResetDirty()
         {

com.unity.multiplayer.mlapi/Runtime/NetworkVariable/Collections/NetworkSet.cs

@@ -73,6 +73,8 @@ public NetworkSet(ISet<T> value)
             m_Set = value;
         }
 
+        public string Name { get; set; }
+
         /// <inheritdoc />
         public void ResetDirty()
         {

com.unity.multiplayer.mlapi/Runtime/NetworkVariable/INetworkVariable.cs

@@ -74,5 +74,6 @@ public interface INetworkVariable
         /// <param name="behaviour">The behaviour the container behaves to</param>
         void SetNetworkBehaviour(NetworkBehaviour behaviour);
 
+        string Name { get; set; }
     }
 }

com.unity.multiplayer.mlapi/Runtime/NetworkVariable/NetworkVariable.cs

@@ -90,6 +90,8 @@ public T Value
 
         private bool m_IsDirty = false;
 
+        public string Name { get; set; }
+
         /// <summary>
         /// Sets whether or not the variable needs to be delta synced
         /// </summary>

com.unity.multiplayer.mlapi/Tests/Runtime/Metrics/NetworkMetricsDispatchTests.cs

@@ -32,7 +32,7 @@ public void TearDown()
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenNamedMessageSent_TracksNamedMessageSentMetric()
+        public IEnumerator TrackNamedMessageSentMetric()
         {
             var messageName = Guid.NewGuid().ToString();
 
@@ -53,7 +53,7 @@ public IEnumerator NetworkMetrics_WhenNamedMessageSent_TracksNamedMessageSentMet
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenNamedMessageSentToMultipleClients_TracksNamedMessageSentMetric()
+        public IEnumerator TrackNamedMessageSentMetricToMultipleClients()
         {
             var messageName = Guid.NewGuid().ToString();
 
@@ -75,7 +75,7 @@ public IEnumerator NetworkMetrics_WhenNamedMessageSentToMultipleClients_TracksNa
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenUnnamedMessageSent_TracksNamedMessageSentMetric()
+        public IEnumerator TrackUnnamedMessageSentMetric()
         {
             var clientId = 100UL;
             m_NetworkMetrics.Dispatcher.RegisterObserver(new TestObserver(collection =>
@@ -93,7 +93,7 @@ public IEnumerator NetworkMetrics_WhenUnnamedMessageSent_TracksNamedMessageSentM
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenUnnamedMessageSentToMultipleClients_TracksNamedMessageSentMetric()
+        public IEnumerator TrackUnnamedMessageSentMetricToMultipleClients()
         {
             m_NetworkMetrics.Dispatcher.RegisterObserver(new TestObserver(collection =>
             {

com.unity.multiplayer.mlapi/Tests/Runtime/Metrics/NetworkMetricsReceptionTests.cs

@@ -51,7 +51,7 @@ public IEnumerator TearDown()
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenNamedMessageReceived_TracksNamedMessageReceivedMetric()
+        public IEnumerator TrackNamedMessageReceivedMetric()
         {
             var messageName = Guid.NewGuid().ToString();
             LogAssert.Expect(LogType.Log, $"Received from {m_Server.LocalClientId}");
@@ -88,7 +88,7 @@ public IEnumerator NetworkMetrics_WhenNamedMessageReceived_TracksNamedMessageRec
         }
 
         [UnityTest]
-        public IEnumerator NetworkMetrics_WhenUnnamedMessageReceived_TracksUnnamedMessageReceivedMetric()
+        public IEnumerator TrackUnnamedMessageReceivedMetric()
         {
             var found = false;
             m_ClientMetrics.Dispatcher.RegisterObserver(new TestObserver(collection =>