From 60da7e01dd4eb482faf9282f57c049b2a70e68f8 Mon Sep 17 00:00:00 2001
From: eplanet <emeric.planet@gmail.com>
Date: Thu, 23 Feb 2017 22:10:48 +0100
Subject: [PATCH] Added hints for helping user understand metrics meaning

---
 app/views/broker/brokerViewContent.scala.html |  2 +-
 app/views/topic/topicListContent.scala.html   |  6 +++---
 app/views/topic/topicViewContent.scala.html   | 12 ++++++------
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/app/views/broker/brokerViewContent.scala.html b/app/views/broker/brokerViewContent.scala.html
index f3c6c98d8..dc5fcef60 100644
--- a/app/views/broker/brokerViewContent.scala.html
+++ b/app/views/broker/brokerViewContent.scala.html
@@ -73,7 +73,7 @@
                     <th>Total Partitions</th>
                     <th>Partitions on Broker</th>
                     <th>Partitions</th>
-                    <th>Skewed?</th>
+                    <th><span title="Broker has more partitions than the average">Skewed?</span></th>
                 </tr>
                 </thead>
                 <tbody>
diff --git a/app/views/topic/topicListContent.scala.html b/app/views/topic/topicListContent.scala.html
index c00c95ea5..e5daa6c6f 100644
--- a/app/views/topic/topicListContent.scala.html
+++ b/app/views/topic/topicListContent.scala.html
@@ -49,10 +49,10 @@
     <tr><th>Topic</th>
         <th># Partitions</th>
         <th># Brokers</th>
-        <th>Brokers Spread %</th>
-        <th>Brokers Skew %</th>
+        <th><span title="Percentage of cluster brokers having partitions from the topic">Brokers Spread %</span></th>
+        <th><span title="Percentage of brokers having more partitions than the average">Brokers Skew %</span></th>
         <th># Replicas</th>
-        <th>Under Replicated %</th>
+        <th><span title="Percentage of partitions having a missing replica">Under Replicated %</span></th>
         @if(displayTopicSize){
         <th>Leader Size</th>
         }
diff --git a/app/views/topic/topicViewContent.scala.html b/app/views/topic/topicViewContent.scala.html
index 21a286909..3237924da 100644
--- a/app/views/topic/topicViewContent.scala.html
+++ b/app/views/topic/topicViewContent.scala.html
@@ -116,7 +116,7 @@
                     <td>@topicIdentity.partitions</td>
                 </tr>
                 <tr>
-                    <td>Sum of partition offsets</td>
+                    <td><span title="Represents the theoretical size of the topic">Sum of partition offsets</span></td>
                     <td>@topicIdentity.summedTopicOffsets</td>
                 </tr>
                 <tr>
@@ -128,25 +128,25 @@
                     <td>@topicIdentity.topicBrokers</td>
                 </tr>
                 <tr>
-                    <td>Preferred Replicas %</td>
+                    <td><span title="Percentage of replicas leader being preferred (first in the list of replicas)">Preferred Replicas %</td>
                     <td class="@getPreferredReplicasLevel(topicIdentity.preferredReplicasPercentage)">
                         @topicIdentity.preferredReplicasPercentage
                     </td>
                 </tr>
                 <tr>
-                    <td>Brokers Skewed %</td>
+                    <td><span title="Percentage of brokers having more partitions than the average">Brokers Skewed %</span></td>
                     <td class="@getBrokersSkewedLevel(topicIdentity.brokersSkewPercentage)">
                         @topicIdentity.brokersSkewPercentage
                     </td>
                 </tr>
                 <tr>
-                    <td>Brokers Spread %</td>
+                    <td><span title="Percentage of cluster brokers having partitions from the topic">Brokers Spread %</span></td>
                     <td class="@getBrokersSpreadLevel(topicIdentity.brokersSpreadPercentage)">
                         @topicIdentity.brokersSpreadPercentage
                     </td>
                 </tr>
                 <tr>
-                    <td>Under-replicated %</td>
+                    <td><span title="Percentage of partitions having a missing replica">Under-replicated %</span></td>
                     <td class="@getUnderReplicatedLevel(topicIdentity.underReplicatedPercentage)">
                         @topicIdentity.underReplicatedPercentage
                     </td>
@@ -239,7 +239,7 @@
             <div class="panel-heading"><h4>Partitions by Broker</h4></div>
             <table class="table" style="table-layout: fixed; width: 100%">
                 <thead>
-                <tr><th>Broker</th><th># of Partitions</th><th>Partitions</th><th>Skewed?</th></tr>
+                <tr><th>Broker</th><th># of Partitions</th><th>Partitions</th><th><span title="Broker has more partitions than the average">Skewed?</span></th></tr>
                 </thead>
                 <tbody>
                 @for(btp <- topicIdentity.partitionsByBroker) {