From 8fa3addda3501ee44308f15e5331b1d27d280565 Mon Sep 17 00:00:00 2001
From: AMZN-Olex <5432499+AMZN-Olex@users.noreply.github.com>
Date: Tue, 27 Jul 2021 00:21:40 -0400
Subject: [PATCH] Added debug overlay for entitie with high network costs

Signed-off-by: AMZN-Olex <5432499+AMZN-Olex@users.noreply.github.com>
---
 .../MultiplayerDebugPerEntityReporter.cpp     | 37 +++++++++++++++++++
 .../Debug/MultiplayerDebugSystemComponent.cpp |  2 +-
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugPerEntityReporter.cpp b/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugPerEntityReporter.cpp
index 3517dfa86a..30e6feb2f4 100644
--- a/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugPerEntityReporter.cpp
+++ b/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugPerEntityReporter.cpp
@@ -7,6 +7,10 @@
  */
 
 #include "MultiplayerDebugPerEntityReporter.h"
+
+#include <AzCore/Component/TransformBus.h>
+#include <AzCore/Math/ToString.h>
+#include <AzFramework/Entity/EntityDebugDisplayBus.h>
 #include <Multiplayer/IMultiplayer.h>
 
 #if defined(IMGUI_ENABLED)
@@ -117,6 +121,17 @@ namespace MultiplayerDiagnostics
         static ImGuiTextFilter filter;
         filter.Draw();
 
+        char status[100] = {};
+
+        struct NetworkEntityTraffic
+        {
+            const char* m_name = nullptr;
+            float m_up = 0.f;
+            float m_down = 0.f;
+        };
+
+        AZStd::fixed_unordered_map<AZ::EntityId, NetworkEntityTraffic, 5, 10> networkEntitiesTraffic;
+
         if (ImGui::CollapsingHeader("Receiving Entities"))
         {
             for (AZStd::pair<AZ::EntityId, EntityReporter>& entityPair : m_receivingEntityReports)
@@ -132,6 +147,9 @@ namespace MultiplayerDiagnostics
                     DisplayReplicatedStateReport(entityPair.second.GetComponentReports(), m_replicatedStateKbpsWarn, m_replicatedStateMaxSizeWarn);
                     ImGui::TreePop();
                 }
+
+                networkEntitiesTraffic[entityPair.first].m_name = entityPair.second.GetEntityName();
+                networkEntitiesTraffic[entityPair.first].m_down = entityPair.second.GetKbitsPerSecond();
             }
         }
 
@@ -151,8 +169,27 @@ namespace MultiplayerDiagnostics
                     DisplayReplicatedStateReport(entityPair.second.GetComponentReports(), m_replicatedStateKbpsWarn, m_replicatedStateMaxSizeWarn);
                     ImGui::TreePop();
                 }
+
+                networkEntitiesTraffic[entityPair.first].m_name = entityPair.second.GetEntityName();
+                networkEntitiesTraffic[entityPair.first].m_up = entityPair.second.GetKbitsPerSecond();
             }
         }
+
+        constexpr float trafficThreshold = 0.1f;
+        for (AZStd::pair<AZ::EntityId, NetworkEntityTraffic>& networkEntity : networkEntitiesTraffic)
+        {
+            if (networkEntity.second.m_down < trafficThreshold && networkEntity.second.m_up < trafficThreshold)
+            {
+                continue;
+            }
+
+            azsprintf(status, "%s - %.0f down / %0.f up (kbps)", networkEntity.second.m_name, networkEntity.second.m_down, networkEntity.second.m_up);
+            AZ::Vector3 entityPosition = AZ::Vector3::CreateZero();
+            constexpr bool centerText = true;
+            AZ::TransformBus::EventResult(entityPosition, networkEntity.first, &AZ::TransformBus::Events::GetWorldTranslation);
+            AzFramework::DebugDisplayRequestBus::Broadcast(&AzFramework::DebugDisplayRequestBus::Events::DrawTextLabel,
+                entityPosition, 1.0f, status, centerText, 0, 0);
+        }
 #endif
     }
 
diff --git a/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugSystemComponent.cpp b/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugSystemComponent.cpp
index 73afc45271..44e2f9f6bf 100644
--- a/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugSystemComponent.cpp
+++ b/Gems/Multiplayer/Code/Source/Debug/MultiplayerDebugSystemComponent.cpp
@@ -329,7 +329,7 @@ namespace Multiplayer
 
         if (m_displayPerEntityStats)
         {
-            if (ImGui::Begin("Multiplayer Per Entity Analytics", &m_displayPerEntityStats))
+            if (ImGui::Begin("Multiplayer Per Entity Analytics", &m_displayPerEntityStats, ImGuiWindowFlags_None))
             {
                 if (m_reporter)
                 {