Skip to content

feat: Track scene event metrics #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
josiemessa merged 13 commits into from
Aug 31, 2021
Merged

feat: Track scene event metrics #1089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
60f5217
Track Scene Event Metrics in runtime
Aug 25, 2021
56c2e2a
Track scene event metrics in runtime code.
Aug 25, 2021
b2ddbe9
remove unused import
Aug 25, 2021
7d99b9d
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 26, 2021
e9d0491
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 26, 2021
f7742f3
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 27, 2021
0f95378
Merge branch 'feat/MTT-748-scene-metrics' of github.com:Unity-Technol…
Aug 27, 2021
09ec93b
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 27, 2021
6bd2724
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 31, 2021
280f2ae
Merge branch 'feat/MTT-748-scene-metrics' of github.com:Unity-Technol…
Aug 31, 2021
d6a68fb
Merge branch 'develop' into feat/MTT-748-scene-metrics
Aug 31, 2021
a227877
Change usage of now removed function name
Aug 31, 2021
68a6c0c
Merge branch 'feat/MTT-748-scene-metrics' of github.com:Unity-Technol…
Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions com.unity.netcode.gameobjects/Runtime/Metrics/INetworkMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ void TrackRpcReceived(

void TrackServerLogReceived(ulong senderClientId, uint logType, long bytesCount);

void TrackSceneEventSent(ulong[] receiverClientIds, uint sceneEventType, string sceneName, long bytesCount);

void TrackSceneEventSent(ulong receiverClientId, uint sceneEventType, string sceneName, long bytesCount);

void TrackSceneEventReceived(ulong senderClientId, uint sceneEventType, string sceneName, long bytesCount);

void DispatchFrame();
}
}
21 changes: 21 additions & 0 deletions com.unity.netcode.gameobjects/Runtime/Metrics/NetworkMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ internal class NetworkMetrics : INetworkMetrics
readonly EventMetric<RpcEvent> m_RpcReceivedEvent = new EventMetric<RpcEvent>(MetricNames.RpcReceived);
readonly EventMetric<ServerLogEvent> m_ServerLogSentEvent = new EventMetric<ServerLogEvent>(MetricNames.ServerLogSent);
readonly EventMetric<ServerLogEvent> m_ServerLogReceivedEvent = new EventMetric<ServerLogEvent>(MetricNames.ServerLogReceived);
readonly EventMetric<SceneEventMetric> m_SceneEventSentEvent = new EventMetric<SceneEventMetric>(MetricNames.SceneEventSent);
readonly EventMetric<SceneEventMetric> m_SceneEventReceivedEvent = new EventMetric<SceneEventMetric>(MetricNames.SceneEventReceived);

readonly Dictionary<ulong, NetworkObjectIdentifier> m_NetworkGameObjects = new Dictionary<ulong, NetworkObjectIdentifier>();

Expand All @@ -38,6 +40,7 @@ public NetworkMetrics()
.WithMetricEvents(m_ObjectDestroySentEvent, m_ObjectDestroyReceivedEvent)
.WithMetricEvents(m_RpcSentEvent, m_RpcReceivedEvent)
.WithMetricEvents(m_ServerLogSentEvent, m_ServerLogReceivedEvent)
.WithMetricEvents(m_SceneEventSentEvent, m_SceneEventReceivedEvent)
.Build();

Dispatcher.RegisterObserver(NetcodeObserver.Observer);
Expand Down Expand Up @@ -226,6 +229,24 @@ public void TrackServerLogReceived(ulong senderClientId, uint logType, long byte
m_ServerLogReceivedEvent.Mark(new ServerLogEvent(new ConnectionInfo(senderClientId), (Unity.Multiplayer.Tools.MetricTypes.LogLevel)logType, bytesCount));
}

public void TrackSceneEventSent(ulong[] receiverClientIds, uint sceneEventType, string sceneName, long bytesCount)
Copy link
Copy Markdown
Contributor

@bendoyon bendoyon Aug 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will we have tests for this?

Copy link
Copy Markdown
Author

@josiemessa josiemessa Aug 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I've been digging into what I can do programmatically vs. need to do manually! I have manually verified they show up though, but next on the list is the tests.

Copy link
Copy Markdown

@Rosme Rosme Aug 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might be able to reuse the tests that were written by the SDK team if there are.

Copy link
Copy Markdown
Author

@josiemessa josiemessa Aug 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's what I'm looking at, as there's both programmatic and manual tests so need to see what's being tested in which.

{
foreach (var receiverClientId in receiverClientIds)
{
TrackSceneEventSent(receiverClientId, sceneEventType, sceneName, bytesCount);
}
}

public void TrackSceneEventSent(ulong receiverClientId, uint sceneEventType, string sceneName, long bytesCount)
{
m_SceneEventSentEvent.Mark(new SceneEventMetric(new ConnectionInfo(receiverClientId), (SceneEventType)sceneEventType, sceneName, bytesCount));
}

public void TrackSceneEventReceived(ulong senderClientId, uint sceneEventType, string sceneName, long bytesCount)
{
m_SceneEventReceivedEvent.Mark(new SceneEventMetric(new ConnectionInfo(senderClientId), (SceneEventType)sceneEventType, sceneName, bytesCount));
}

public void DispatchFrame()
{
Dispatcher.Dispatch();
Expand Down
12 changes: 12 additions & 0 deletions com.unity.netcode.gameobjects/Runtime/Metrics/NullNetworkMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,18 @@ public void TrackServerLogReceived(ulong senderClientId, uint logType, long byte
{
}

public void TrackSceneEventSent(ulong[] receiverClientIds, uint sceneEventType, string sceneName, long bytesCount)
{
}

public void TrackSceneEventSent(ulong receiverClientId, uint sceneEventType, string sceneName, long bytesCount)
{
}

public void TrackSceneEventReceived(ulong senderClientId, uint sceneEventType, string sceneName, long bytesCount)
{
}

public void DispatchFrame()
{
}
Expand Down
80 changes: 73 additions & 7 deletions com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,12 +415,20 @@ private void SendSceneEventData(ulong[] targetClientIds)
return;
}

var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(k_MessageType, k_ChannelType, targetClientIds, k_NetworkUpdateStage);
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(
k_MessageType, k_ChannelType, targetClientIds, k_NetworkUpdateStage);

if (context != null)
{
using var nonNullContext = (InternalCommandContext)context;
var bufferSizeCapture = new CommandContextSizeCapture(nonNullContext);
bufferSizeCapture.StartMeasureSegment();

SceneEventData.OnWrite(nonNullContext.NetworkWriter);

var size = bufferSizeCapture.StopMeasureSegment();
m_NetworkManager.NetworkMetrics.TrackSceneEventSent(
targetClientIds, (uint)SceneEventData.SceneEventType, ScenesInBuild[(int)SceneEventData.SceneIndex], size);
return;
}

Expand Down Expand Up @@ -568,7 +576,8 @@ private SceneEventProgress ValidateSceneEvent(string sceneName, bool isUnloading
private bool OnSceneEventProgressCompleted(SceneEventProgress sceneEventProgress)
{
// Send a message to all clients that all clients are done loading or unloading
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(k_MessageType, k_ChannelType, m_NetworkManager.ConnectedClientsIds, k_NetworkUpdateStage);
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(
k_MessageType, k_ChannelType, m_NetworkManager.ConnectedClientsIds, k_NetworkUpdateStage);
if (context != null)
{
using var nonNullContext = (InternalCommandContext)context;
Expand All @@ -577,7 +586,18 @@ private bool OnSceneEventProgressCompleted(SceneEventProgress sceneEventProgress
ClientSynchEventData.SceneEventType = sceneEventProgress.SceneEventType;
ClientSynchEventData.ClientsCompleted = sceneEventProgress.DoneClients;
ClientSynchEventData.ClientsTimedOut = m_NetworkManager.ConnectedClients.Keys.Except(sceneEventProgress.DoneClients).ToList();

var bufferSizeCapture = new CommandContextSizeCapture(nonNullContext);
bufferSizeCapture.StartMeasureSegment();

ClientSynchEventData.OnWrite(nonNullContext.NetworkWriter);

var size = bufferSizeCapture.StopMeasureSegment();
m_NetworkManager.NetworkMetrics.TrackSceneEventSent(
m_NetworkManager.ConnectedClientsIds,
(uint)sceneEventProgress.SceneEventType,
ScenesInBuild[(int)sceneEventProgress.SceneIndex],
size);
}

// Send a local notification to the server that all clients are done loading or unloading
Expand Down Expand Up @@ -1023,14 +1043,21 @@ private void OnServerLoadedScene(Scene scene)
var clientId = m_NetworkManager.ConnectedClientsList[j].ClientId;
if (clientId != m_NetworkManager.ServerClientId)
{
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(k_MessageType, k_ChannelType, new ulong[] { clientId }, k_NetworkUpdateStage);
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(
k_MessageType, k_ChannelType, new ulong[] { clientId }, k_NetworkUpdateStage);
if (context != null)
{
// Set the target client id that will be used during in scene NetworkObject serialization
SceneEventData.TargetClientId = clientId;

using var nonNullContext = (InternalCommandContext)context;

var bufferSizeCapture = new CommandContextSizeCapture(nonNullContext);
bufferSizeCapture.StartMeasureSegment();

SceneEventData.OnWrite(nonNullContext.NetworkWriter);

var size = bufferSizeCapture.StopMeasureSegment();
m_NetworkManager.NetworkMetrics.TrackSceneEventSent(clientId, (uint)SceneEventData.SceneEventType, scene.name, size);
}
else
{
Expand Down Expand Up @@ -1131,11 +1158,24 @@ internal void SynchronizeNetworkObjects(ulong clientId)

ClientSynchEventData.AddSpawnedNetworkObjects();

var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(k_MessageType, k_ChannelType, new ulong[] { clientId }, k_NetworkUpdateStage);
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(
k_MessageType, k_ChannelType, new ulong[] { clientId }, k_NetworkUpdateStage);
if (context != null)
{

using var nonNullContext = (InternalCommandContext)context;

var bufferSizeCapture = new CommandContextSizeCapture(nonNullContext);
bufferSizeCapture.StartMeasureSegment();

ClientSynchEventData.OnWrite(nonNullContext.NetworkWriter);

var size = bufferSizeCapture.StopMeasureSegment();
foreach (var sceneIndex in ClientSynchEventData.ScenesToSynchronize)
{
m_NetworkManager.NetworkMetrics.TrackSceneEventSent(
clientId, (uint)ClientSynchEventData.SceneEventType,ScenesInBuild[(int)sceneIndex], size);
}
}

// Notify the local server that the client has been sent the SceneEventData.SceneEventTypes.S2C_Event_Sync event
Expand Down Expand Up @@ -1271,12 +1311,19 @@ private void ClientLoadedSynchronization(uint sceneIndex, int sceneHandle)
ClientSynchEventData.SceneEventType = SceneEventData.SceneEventTypes.C2S_LoadComplete;
ClientSynchEventData.SceneIndex = sceneIndex;

var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(k_MessageType, k_ChannelType,
new ulong[] { m_NetworkManager.ServerClientId }, k_NetworkUpdateStage);
var context = m_NetworkManager.MessageQueueContainer.EnterInternalCommandContext(
k_MessageType, k_ChannelType, new ulong[] { m_NetworkManager.ServerClientId }, k_NetworkUpdateStage);
if (context != null)
{
using var nonNullContext = (InternalCommandContext)context;

var bufferSizeCapture = new CommandContextSizeCapture(nonNullContext);
bufferSizeCapture.StartMeasureSegment();

ClientSynchEventData.OnWrite(nonNullContext.NetworkWriter);

var size = bufferSizeCapture.StopMeasureSegment();
m_NetworkManager.NetworkMetrics.TrackSceneEventSent(m_NetworkManager.ServerClientId, (uint)ClientSynchEventData.SceneEventType, sceneName, size);
}

// Send notification to local client that the scene has finished loading
Expand Down Expand Up @@ -1467,6 +1514,25 @@ internal void HandleSceneEvent(ulong clientId, Stream stream)
var reader = NetworkReaderPool.GetReader(stream);
SceneEventData.OnRead(reader);
NetworkReaderPool.PutBackInPool(reader);

if (SceneEventData.SceneEventType == SceneEventData.SceneEventTypes.S2C_Sync)
{
// For this event the server may be sending scene event data about multiple scenes, so we need
// to track a metric for each one.
foreach (var sceneIndex in SceneEventData.ScenesToSynchronize)
{
m_NetworkManager.NetworkMetrics.TrackSceneEventReceived(
clientId, (uint) SceneEventData.SceneEventType, ScenesInBuild[(int)sceneIndex], stream.Length);
}
}
else
{
// For all other scene event types, we are only dealing with one scene at a time, so we can read it
// from the SceneEventData directly.
m_NetworkManager.NetworkMetrics.TrackSceneEventReceived(
clientId, (uint) SceneEventData.SceneEventType, ScenesInBuild[(int)SceneEventData.SceneIndex], stream.Length);
}

if (SceneEventData.IsSceneEventClientSide())
{
HandleClientSceneEvent(stream);
Expand Down