1
2
3
4 package org.apache.hadoop.hbase.tmpl.regionserver;
5
6
7 import java.util.Map;
8
9 import org.apache.hadoop.hbase.io.hfile.BlockCacheUtil.CachedBlocksByFile;
10
11 import org.apache.hadoop.hbase.io.hfile.AgeSnapshot;
12
13 import org.apache.hadoop.hbase.io.hfile.CachedBlock;
14
15 import org.apache.hadoop.conf.Configuration;
16
17 import org.apache.hadoop.hbase.io.hfile.CacheConfig;
18
19 import org.apache.hadoop.hbase.io.hfile.BlockCache;
20
21 import org.apache.hadoop.hbase.io.hfile.bucket.BucketCacheStats;
22
23 import org.apache.hadoop.hbase.io.hfile.bucket.BucketCache;
24
25 import org.apache.hadoop.hbase.io.hfile.bucket.BucketAllocator;
26
27 import org.apache.hadoop.hbase.io.hfile.bucket.BucketAllocator.Bucket;
28
29 import org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix;
30
31 public class BlockCacheTmplImpl
32 extends org.jamon.AbstractTemplateImpl
33 implements org.apache.hadoop.hbase.tmpl.regionserver.BlockCacheTmpl.Intf
34
35 {
36 private final CacheConfig cacheConfig;
37 private final Configuration config;
38 protected static org.apache.hadoop.hbase.tmpl.regionserver.BlockCacheTmpl.ImplData __jamon_setOptionalArguments(org.apache.hadoop.hbase.tmpl.regionserver.BlockCacheTmpl.ImplData p_implData)
39 {
40 return p_implData;
41 }
42 public BlockCacheTmplImpl(org.jamon.TemplateManager p_templateManager, org.apache.hadoop.hbase.tmpl.regionserver.BlockCacheTmpl.ImplData p_implData)
43 {
44 super(p_templateManager, __jamon_setOptionalArguments(p_implData));
45 cacheConfig = p_implData.getCacheConfig();
46 config = p_implData.getConfig();
47 }
48
49 @Override public void renderNoFlush(final java.io.Writer jamonWriter)
50 throws java.io.IOException
51 {
52
53
54 BlockCache bc = cacheConfig == null? null: cacheConfig.getBlockCache();
55 String bcUrl = null;
56 String bcName = null;
57 if (bc != null) {
58 bcUrl = "http://hbase.apache.org/devapidocs/" + bc.getClass().getName().replaceAll("\\.", "/") + ".html";
59 bcName = bc.getClass().getSimpleName();
60 }
61 BlockCache [] bcs = cacheConfig == null? null: cacheConfig.getBlockCache() == null? null: cacheConfig.getBlockCache().getBlockCaches();
62
63 boolean evictions = bcs != null && bcs.length > 1;
64
65
66 jamonWriter.write("<div class=\"tabbable\">\n <ul class=\"nav nav-pills\">\n <li class=\"active\"><a href=\"#tab_bc_baseInfo\" data-toggle=\"tab\">Base Info</a></li>\n <li class=\"\"><a href=\"#tab_bc_config\" data-toggle=\"tab\">Config</a></li>\n <li class=\"\"><a href=\"#tab_bc_stats\" data-toggle=\"tab\">Stats</a></li>\n <li class=\"\"><a href=\"#tab_bc_l1\" data-toggle=\"tab\">L1</a></li>\n <li class=\"\"><a href=\"#tab_bc_l2\" data-toggle=\"tab\">L2</a></li>\n </ul>\n <div class=\"tab-content\" style=\"padding-bottom: 9px; border-bottom: 1px solid #ddd;\">\n <div class=\"tab-pane active\" id=\"tab_bc_baseInfo\">\n ");
67
68 {
69
70 __jamon_innerUnit__bc_baseInfo(jamonWriter, cacheConfig, bcUrl, bcName);
71 }
72
73 jamonWriter.write("\n </div>\n <div class=\"tab-pane\" id=\"tab_bc_config\">\n ");
74
75 {
76
77 __jamon_innerUnit__bc_config(jamonWriter, cacheConfig );
78 }
79
80 jamonWriter.write("\n </div>\n <div class=\"tab-pane\" id=\"tab_bc_stats\">\n ");
81
82 {
83
84 __jamon_innerUnit__bc_stats(jamonWriter, cacheConfig );
85 }
86
87 jamonWriter.write("\n </div>\n <div class=\"tab-pane\" id=\"tab_bc_l1\">\n ");
88
89 {
90
91 __jamon_innerUnit__bc_l(jamonWriter, bcs == null? bc: bcs[0], "L1", evictions);
92 }
93
94 jamonWriter.write("\n </div>\n <div class=\"tab-pane\" id=\"tab_bc_l2\">\n ");
95
96 {
97
98 __jamon_innerUnit__bc_l(jamonWriter, bcs == null? null: bcs.length <= 1? null: bcs[1], "L2", evictions);
99 }
100
101 jamonWriter.write("\n </div>\n </div>\n</div>\n\n");
102 }
103
104
105
106 private void __jamon_innerUnit__bc_stats(final java.io.Writer jamonWriter, final CacheConfig cacheConfig)
107 throws java.io.IOException
108 {
109
110 if (cacheConfig == null || cacheConfig.getBlockCache() == null )
111 {
112
113 jamonWriter.write("\n<p>CacheConfig is null</p>\n");
114 }
115
116 else
117 {
118
119 jamonWriter.write("\n<table class=\"table table-striped\">\n <tr>\n <th>Attribute</th>\n <th>Value</th>\n <th>Description</th>\n </tr>\n <tr>\n <td>Size</td>\n <td>");
120
121 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cacheConfig.getBlockCache().getCurrentSize(),
122 "B", 1)), jamonWriter);
123
124 jamonWriter.write("</td>\n <td>Current size of block cache in use (bytes)</td>\n </tr>\n <tr>\n <td>Free</td>\n <td>");
125
126 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cacheConfig.getBlockCache().getFreeSize(),
127 "B", 1)), jamonWriter);
128
129 jamonWriter.write("</td>\n <td>The total free memory currently available to store more cache entries (bytes)</td>\n </tr>\n <tr>\n <td>Count</td>\n <td>");
130
131 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", cacheConfig.getBlockCache().getBlockCount())), jamonWriter);
132
133 jamonWriter.write("</td>\n <td>Number of blocks in block cache</td>\n </tr>\n ");
134
135 {
136
137 __jamon_innerUnit__evictions_tmpl(jamonWriter, cacheConfig.getBlockCache());
138 }
139
140 jamonWriter.write("\n ");
141
142 {
143
144 __jamon_innerUnit__hits_tmpl(jamonWriter, cacheConfig.getBlockCache());
145 }
146
147 jamonWriter.write("\n</table>\n<p>If block cache is made up of more than one cache -- i.e. a L1 and a L2 -- then the above\nare combined counts. Request count is sum of hits and misses.</p>\n");
148 }
149
150 jamonWriter.write("\n");
151 }
152
153
154
155 private void __jamon_innerUnit__hits_tmpl(final java.io.Writer jamonWriter, final BlockCache bc)
156 throws java.io.IOException
157 {
158
159 jamonWriter.write("<tr>\n <td>Hits</td>\n <td>");
160
161 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getHitCount())), jamonWriter);
162
163 jamonWriter.write("</td>\n <td>Number requests that were cache hits</td>\n </tr>\n <tr>\n <td>Hits Caching</td>\n <td>");
164
165 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getHitCachingCount())), jamonWriter);
166
167 jamonWriter.write("</td>\n <td>Cache hit block requests but only requests set to cache block if a miss</td>\n </tr>\n <tr>\n <td>Misses</td>\n <td>");
168
169 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getMissCount())), jamonWriter);
170
171 jamonWriter.write("</td>\n <td>Block requests that were cache misses but set to cache missed blocks</td>\n </tr>\n <tr>\n <td>Misses Caching</td>\n <td>");
172
173 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getMissCount())), jamonWriter);
174
175 jamonWriter.write("</td>\n <td>Block requests that were cache misses but only requests set to use block cache</td>\n </tr>\n <tr>\n <td>Hit Ratio</td>\n <td>");
176
177 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,.2f", bc.getStats().getHitRatio() * 100)), jamonWriter);
178
179 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf("%"), jamonWriter);
180
181 jamonWriter.write("</td>\n <td>Hit Count divided by total requests count</td>\n </tr>\n\n");
182 }
183
184
185
186 private void __jamon_innerUnit__bc_config(final java.io.Writer jamonWriter, final CacheConfig cacheConfig)
187 throws java.io.IOException
188 {
189
190 if (cacheConfig == null )
191 {
192
193 jamonWriter.write("\n<p>CacheConfig is null</p>\n");
194 }
195
196 else
197 {
198
199 jamonWriter.write("\n<table class=\"table table-striped\">\n <tr>\n <th>Attribute</th>\n <th>Value</th>\n <th>Description</th>\n </tr>\n <tr>\n <td>Cache DATA on Read</td>\n <td>");
200
201 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataOnRead()), jamonWriter);
202
203 jamonWriter.write("</td>\n <td>True if DATA blocks are cached on read\n (INDEX & BLOOM blocks are always cached)</td>\n </tr>\n <tr>\n <td>Cache DATA on Write</td>\n <td>");
204
205 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataOnWrite()), jamonWriter);
206
207 jamonWriter.write("</td>\n <td>True if DATA blocks are cached on write.</td>\n </tr>\n <tr>\n <td>Cache INDEX on Write</td>\n <td>");
208
209 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheIndexesOnWrite()), jamonWriter);
210
211 jamonWriter.write("</td>\n <td>True if INDEX blocks are cached on write</td>\n </tr>\n <tr>\n <td>Cache BLOOM on Write</td>\n <td>");
212
213 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheBloomsOnWrite()), jamonWriter);
214
215 jamonWriter.write("</td>\n <td>True if BLOOM blocks are cached on write</td>\n </tr>\n <tr>\n <td>Evict blocks on Close</td>\n <td>");
216
217 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldEvictOnClose()), jamonWriter);
218
219 jamonWriter.write("</td>\n <td>True if blocks are evicted from cache when an HFile\n reader is closed</td>\n </tr>\n <tr>\n <td>Cache DATA in compressed format</td>\n <td>");
220
221 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataCompressed()), jamonWriter);
222
223 jamonWriter.write("</td>\n <td>True if DATA blocks are cached in their compressed form</td>\n </tr>\n <tr>\n <td>Prefetch on Open</td>\n <td>");
224
225 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldPrefetchOnOpen()), jamonWriter);
226
227 jamonWriter.write("</td>\n <td>True if blocks are prefetched into cache on open</td>\n </tr>\n</table>\n");
228 }
229
230 jamonWriter.write("\n");
231 }
232
233
234
235 private void __jamon_innerUnit__bc_baseInfo(final java.io.Writer jamonWriter, final CacheConfig cacheConfig, final String bcUrl, final String bcName)
236 throws java.io.IOException
237 {
238
239
240 BlockCache bc = cacheConfig == null? null: cacheConfig.getBlockCache();
241 BlockCache [] bcs = bc == null? null: bc.getBlockCaches();
242 String bcl1Url = null;
243 String bcl1Name = null;
244 String bcl2Url = null;
245 String bcl2Name = null;
246 if (bcs != null) {
247 BlockCache bcl1 = bcs[0];
248 if (bcl1 != null) {
249 bcl1Url = "http://hbase.apache.org/devapidocs/" + bcl1.getClass().getName().replaceAll("\\.", "/") + ".html";
250 bcl1Name = bcl1.getClass().getSimpleName();
251 }
252 if (bcs.length == 2) {
253 BlockCache bcl2 = bcs[1];
254 bcl2Url = "http://hbase.apache.org/devapidocs/" + bcl2.getClass().getName().replaceAll("\\.", "/") + ".html";
255 bcl2Name = bcl2.getClass().getSimpleName();
256 }
257 }
258
259
260 jamonWriter.write("<table class=\"table table-striped\">\n <tr>\n <th>Attribute</th>\n <th>Value</th>\n <th>Description</th>\n </tr>\n </tr>\n <tr>\n <td>Implementation</td>\n <td><a href=\"");
261
262 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcUrl), jamonWriter);
263
264 jamonWriter.write("\">");
265
266 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcName), jamonWriter);
267
268 jamonWriter.write("</a></td>\n <td>Block cache implementing class</td>\n </tr>\n</table>\n<p>See <a href=\"http://hbase.apache.org/book.html#block.cache\">block cache</a> in the HBase Reference Guide for help.</p>\n");
269 }
270
271
272
273 private void __jamon_innerUnit__block_cache(final java.io.Writer jamonWriter, final BlockCache bc, final String name, final boolean evictions)
274 throws java.io.IOException
275 {
276
277
278 String bcUrl = "http://hbase.apache.org/devapidocs/" + bc.getClass().getName().replaceAll("\\.", "/") + ".html";
279 String bcName = bc.getClass().getSimpleName();
280 org.apache.hadoop.hbase.io.hfile.BlockCacheUtil.CachedBlocksByFile cbsbf =
281 org.apache.hadoop.hbase.io.hfile.BlockCacheUtil.getLoadedCachedBlocksByFile(config, bc);
282 AgeSnapshot cbsbfSnapshot = cbsbf.getAgeInCacheSnapshot();
283
284 boolean bucketCache = bc.getClass().getSimpleName().equals("BucketCache");
285 BucketCacheStats bucketCacheStats = null;
286 BucketAllocator bucketAllocator = null;
287
288 if (bucketCache) {
289 bucketCacheStats = (BucketCacheStats)bc.getStats();
290 bucketAllocator = ((BucketCache)bc).getAllocator();
291 }
292
293
294 if (cbsbf.isFull() )
295 {
296
297 jamonWriter.write("\n<p>\n<div class=\"alert alert-danger\">\n<strong>The stats below are incomplete!</strong> We ran into our accounting limit of ");
298
299 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cbsbf.getCount()), jamonWriter);
300
301 jamonWriter.write(" blocks. Up the configuration <i>hbase.ui.blockcache.by.file.max</i>.\n</div>\n</p> \n");
302 }
303
304 jamonWriter.write("\n<table id=\"blocks_summary\" class=\"table table-striped\">\n <tr>\n <th>Attribute</th>\n <th>Value</th>\n <th>Description</th>\n </tr>\n <tr>\n <td>Implementation</td>\n <td><a href=\"");
305
306 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcUrl), jamonWriter);
307
308 jamonWriter.write("\">");
309
310 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bc.getClass().getSimpleName()), jamonWriter);
311
312 jamonWriter.write("</a></td>\n <td>Class implementing this block cache Level</td>\n </tr>\n");
313
314 if (bucketCache )
315 {
316
317 jamonWriter.write("\n <tr>\n <td>Implementation</td>\n <td>");
318
319 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(((BucketCache)bc).getIoEngine()), jamonWriter);
320
321 jamonWriter.write("</a></td>\n <td>IOEngine</td>\n </tr>\n");
322 }
323
324 jamonWriter.write("\n <tr>\n <td>Cache Size Limit</td>\n <td>");
325
326 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(bc.getMaxSize(), "B", 1)), jamonWriter);
327
328 jamonWriter.write("</td>\n <td>Max size of cache</td>\n </tr>\n <tr>\n <td>Block Count</td>\n <td>");
329
330 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getBlockCount())), jamonWriter);
331
332 jamonWriter.write("</td>\n <td>Count of Blocks</td>\n </tr>\n");
333
334 if (!bucketCache )
335 {
336
337 jamonWriter.write("\n <tr>\n <td>Data Block Count</td>\n <td>");
338
339 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getDataBlockCount())), jamonWriter);
340
341 jamonWriter.write("</td>\n <td>Count of DATA Blocks</td>\n </tr>\n");
342 }
343
344 jamonWriter.write("\n <tr>\n <td>Size of Blocks</td>\n <td>");
345
346 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(bc.getCurrentSize(), "B", 1)), jamonWriter);
347
348 jamonWriter.write("</td>\n <td>Size of Blocks</td>\n </tr>\n");
349
350 if (!bucketCache )
351 {
352
353 jamonWriter.write("\n <tr>\n <td>Size of Data Blocks</td>\n <td>");
354
355 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(bc.getCurrentDataSize(), "B", 1)), jamonWriter);
356
357 jamonWriter.write("</td>\n <td>Size of DATA Blocks</td>\n </tr>\n");
358 }
359
360 jamonWriter.write(" \n");
361
362 {
363
364 __jamon_innerUnit__evictions_tmpl(jamonWriter, bc);
365 }
366
367 jamonWriter.write("\n");
368
369 {
370
371 __jamon_innerUnit__hits_tmpl(jamonWriter, bc);
372 }
373
374 jamonWriter.write("\n\n");
375
376 if (bucketCache )
377 {
378
379 jamonWriter.write("\n <tr>\n <td>Hits per Second</td>\n <td>");
380
381 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bucketCacheStats.getIOHitsPerSecond()), jamonWriter);
382
383 jamonWriter.write("</td>\n <td>Block gets against this cache per second</td>\n </tr>\n <tr>\n <td>Time per Hit</td>\n <td>");
384
385 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bucketCacheStats.getIOTimePerHit()), jamonWriter);
386
387 jamonWriter.write("</td>\n <td>Time per cache hit</td>\n </tr>\n");
388 }
389
390 jamonWriter.write("\n</table>\n<p>View block cache <a href=\"?format=json&bcn=");
391
392 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
393
394 jamonWriter.write("\">as JSON</a> | Block cache <a href=\"?format=json&bcn=");
395
396 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
397
398 jamonWriter.write("&bcv=file\">as JSON by file</a></p>\n");
399
400
401 cbsbf = null;
402
403 }
404
405
406
407 private void __jamon_innerUnit__bc_l(final java.io.Writer jamonWriter, final BlockCache bc, final String name, final boolean evictions)
408 throws java.io.IOException
409 {
410
411 if (bc == null )
412 {
413
414 jamonWriter.write("\n<p>No ");
415
416 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
417
418 jamonWriter.write(" deployed</p>\n");
419 }
420
421 else
422 {
423
424 jamonWriter.write("\n");
425
426 {
427
428 __jamon_innerUnit__block_cache(jamonWriter, bc, name, evictions);
429 }
430
431 jamonWriter.write("\n");
432 }
433
434 jamonWriter.write("\n");
435 }
436
437
438
439 private void __jamon_innerUnit__evictions_tmpl(final java.io.Writer jamonWriter, final BlockCache bc)
440 throws java.io.IOException
441 {
442
443
444 AgeSnapshot ageAtEvictionSnapshot = bc.getStats().getAgeAtEvictionSnapshot();
445
446
447
448 jamonWriter.write("<tr>\n <td>Evicted</td>\n <td>");
449
450 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getEvictedCount())), jamonWriter);
451
452 jamonWriter.write("</td>\n <td>The total number of blocks evicted</td>\n </tr>\n <tr>\n <td>Evictions</td>\n <td>");
453
454 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getEvictionCount())), jamonWriter);
455
456 jamonWriter.write("</td>\n <td>The total number of times an eviction has occurred</td>\n </tr>\n <tr>\n <td>Mean</td>\n <td>");
457
458 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", (long)ageAtEvictionSnapshot.getMean())), jamonWriter);
459
460 jamonWriter.write("</td>\n <td>Mean age of Blocks at eviction time (seconds)</td>\n </tr>\n");
461 }
462
463
464 }