From 492f1f6d44152c11dae4f11eb2b2f20793f964bf Mon Sep 17 00:00:00 2001
From: Michael Stack <stack@apache.org>
Date: Fri, 13 Jun 2014 11:02:23 -0700
Subject: [PATCH] HBASE-8315 Documentation should have more information of LRU
 Stats

---
 .../tmpl/regionserver/BlockCacheTmpl.jamon    | 30 +++++++++----------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/hbase-server/src/main/jamon/org/apache/hadoop/hbase/tmpl/regionserver/BlockCacheTmpl.jamon b/hbase-server/src/main/jamon/org/apache/hadoop/hbase/tmpl/regionserver/BlockCacheTmpl.jamon
index 5e942792720..1aed29a27f9 100644
--- a/hbase-server/src/main/jamon/org/apache/hadoop/hbase/tmpl/regionserver/BlockCacheTmpl.jamon
+++ b/hbase-server/src/main/jamon/org/apache/hadoop/hbase/tmpl/regionserver/BlockCacheTmpl.jamon
@@ -110,10 +110,10 @@ org.apache.hadoop.util.StringUtils;
     <tr>
         <td>Implementation</td>
         <td><a href="<% bcUrl %>"><% bcName %></a></td>
-        <td>Block Cache implementing class</td>
+        <td>Block cache implementing class</td>
     </tr>
 </table>
-<p>See <a href="http://hbase.apache.org/book.html#block.cache">Block Cache</a> in the HBase Reference Guide for help.</p>
+<p>See <a href="http://hbase.apache.org/book.html#block.cache">block cache</a> in the HBase Reference Guide for help.</p>
 </%def>
 
 <%def bc_config>
@@ -185,28 +185,28 @@ org.apache.hadoop.util.StringUtils;
     </tr>
     <tr>
         <td>Size</td>
-        <td><% StringUtils.humanReadableInt(cacheConfig.getBlockCache().size()) %></td>
-        <td>Total size of Block Cache (bytes)</td>
+        <td><% StringUtils.humanReadableInt(cacheConfig.getBlockCache().getCurrentSize()) %></td>
+        <td>Current size of block cache in use (bytes)</td>
     </tr>
     <tr>
         <td>Free</td>
         <td><% StringUtils.humanReadableInt(cacheConfig.getBlockCache().getFreeSize()) %></td>
-        <td>Free space in Block Cache (bytes)</td>
+        <td>The total free memory currently available to store more cache entries (bytes)</td>
     </tr>
     <tr>
         <td>Count</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getBlockCount()) %></td>
-        <td>Number of blocks in Block Cache</td>
+        <td>Number of blocks in block cache</td>
     </tr>
     <tr>
         <td>Evicted</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getStats().getEvictedCount()) %></td>
-        <td>Number of blocks evicted</td>
+        <td>The total number of blocks evicted</td>
     </tr>
     <tr>
         <td>Evictions</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getStats().getEvictionCount()) %></td>
-        <td>Number of times an eviction occurred</td>
+        <td>The total number of times an eviction has occurred</td>
     </tr>
     <tr>
         <td>Hits</td>
@@ -216,17 +216,17 @@ org.apache.hadoop.util.StringUtils;
     <tr>
         <td>Hits Caching</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getStats().getHitCachingCount()) %></td>
-        <td>Cache hit block requests but only requests set to use Block Cache</td>
+        <td>Cache hit block requests but only requests set to cache block if a miss</td>
     </tr>
     <tr>
         <td>Misses</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getStats().getMissCount()) %></td>
-        <td>Number of requests that were cache misses</td>
+        <td>Block requests that were cache misses but set to cache missed blocks</td>
     </tr>
     <tr>
         <td>Misses Caching</td>
         <td><% String.format("%,d", cacheConfig.getBlockCache().getStats().getMissCount()) %></td>
-        <td>Block requests that were cache misses but only requests set to use Block Cache</td>
+        <td>Block requests that were cache misses but only requests set to use block cache</td>
     </tr>
     <tr>
         <td>Hit Ratio</td>
@@ -234,7 +234,7 @@ org.apache.hadoop.util.StringUtils;
         <td>Hit Count divided by total requests count</td>
     </tr>
 </table>
-<p>If Block Cache is made up of more than one cache -- i.e. a L1 and a L2 -- then the above
+<p>If block cache is made up of more than one cache -- i.e. a L1 and a L2 -- then the above
 are combined counts. Request count is sum of hits and misses.</p>
 </%if>
 </%def>
@@ -292,7 +292,7 @@ are combined counts. Request count is sum of hits and misses.</p>
     <tr>
         <td>Implementation</td>
         <td><a href="<% bcUrl %>"><% bc.getClass().getSimpleName() %></a></td>
-        <td>Class implementing this Block Cache Level</td>
+        <td>Class implementing this block cache Level</td>
     </tr>
 <%if bucketCache %>
     <tr>
@@ -371,8 +371,8 @@ are combined counts. Request count is sum of hits and misses.</p>
     </tr>
 </%if>
 </table>
-<%doc>Call through to Block Cache Detail rendering template</%doc>
-<p>View Block Cache <a href="?format=json&bcn=<% name %>">as JSON</a> | Block Cache <a href="?format=json&bcn=<% name %>&bcv=file">as JSON by file</a></p>
+<%doc>Call through to block cache Detail rendering template</%doc>
+<p>View block cache <a href="?format=json&bcn=<% name %>">as JSON</a> | Block cache <a href="?format=json&bcn=<% name %>&bcv=file">as JSON by file</a></p>
 <%if bucketCache %>
 <p>BucketCache does not discern between DATA and META blocks so we do not show DATA counts (If deploy is using CombinedBlockCache, BucketCache is only DATA blocks</p>
 <h3>BucketCache Buckets</h3>