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_l(final java.io.Writer jamonWriter, final BlockCache bc, final String name, final boolean evictions)
107 throws java.io.IOException
108 {
109
110 if (bc == null )
111 {
112
113 jamonWriter.write("\n<p>No ");
114
115 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
116
117 jamonWriter.write(" deployed</p>\n");
118 }
119
120 else
121 {
122
123 jamonWriter.write("\n");
124
125 {
126
127 __jamon_innerUnit__block_cache(jamonWriter, bc, name, evictions);
128 }
129
130 jamonWriter.write("\n");
131 }
132
133 jamonWriter.write("\n");
134 }
135
136
137
138 private void __jamon_innerUnit__block_cache(final java.io.Writer jamonWriter, final BlockCache bc, final String name, final boolean evictions)
139 throws java.io.IOException
140 {
141
142
143 final long nanosPerSecond = 1000000000;
144 String bcUrl = "http://hbase.apache.org/devapidocs/" + bc.getClass().getName().replaceAll("\\.", "/") + ".html";
145 String bcName = bc.getClass().getSimpleName();
146 org.apache.hadoop.hbase.io.hfile.BlockCacheUtil.CachedBlocksByFile cbsbf =
147 org.apache.hadoop.hbase.io.hfile.BlockCacheUtil.getLoadedCachedBlocksByFile(config, bc);
148 AgeSnapshot cbsbfSnapshot = cbsbf.getAgeInCacheSnapshot();
149
150 boolean bucketCache = bc.getClass().getSimpleName().equals("BucketCache");
151 BucketCacheStats bucketCacheStats = null;
152 BucketAllocator bucketAllocator = null;
153
154 if (bucketCache) {
155 bucketCacheStats = (BucketCacheStats)bc.getStats();
156 bucketAllocator = ((BucketCache)bc).getAllocator();
157 }
158
159
160 if (cbsbf.isFull() )
161 {
162
163 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 ");
164
165 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cbsbf.getCount()), jamonWriter);
166
167 jamonWriter.write(" blocks. Up the configuration <i>hbase.ui.blockcache.by.file.max</i>.\n</div>\n</p> \n");
168 }
169
170 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=\"");
171
172 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcUrl), jamonWriter);
173
174 jamonWriter.write("\">");
175
176 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bc.getClass().getSimpleName()), jamonWriter);
177
178 jamonWriter.write("</a></td>\n <td>Class implementing this block cache Level</td>\n </tr>\n");
179
180 if (bucketCache )
181 {
182
183 jamonWriter.write("\n <tr>\n <td>Implementation</td>\n <td>");
184
185 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(((BucketCache)bc).getIoEngine()), jamonWriter);
186
187 jamonWriter.write("</a></td>\n <td>IOEngine</td>\n </tr>\n");
188 }
189
190 jamonWriter.write("\n <tr>\n <td>Count</td>\n <td>");
191
192 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", cbsbf.getCount())), jamonWriter);
193
194 jamonWriter.write("</td>\n <td>Count of Blocks</td>\n </tr>\n");
195
196 if (!bucketCache )
197 {
198
199 jamonWriter.write("\n <tr>\n <td>Count</td>\n <td>");
200
201 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", cbsbf.getDataCount())), jamonWriter);
202
203 jamonWriter.write("</td>\n <td>Count of DATA Blocks</td>\n </tr>\n");
204 }
205
206 jamonWriter.write("\n <tr>\n <td>Size</td>\n <td>");
207
208 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cbsbf.getSize(), "B", 1)), jamonWriter);
209
210 jamonWriter.write("</td>\n <td>Size of Blocks</td>\n </tr>\n");
211
212 if (!bucketCache )
213 {
214
215 jamonWriter.write("\n <tr>\n <td>Size</td>\n <td>");
216
217 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cbsbf.getDataSize(), "B", 1)), jamonWriter);
218
219 jamonWriter.write("</td>\n <td>Size of DATA Blocks</td>\n </tr>\n");
220 }
221
222 jamonWriter.write(" \n");
223
224 {
225
226 __jamon_innerUnit__evictions_tmpl(jamonWriter, bc);
227 }
228
229 jamonWriter.write("\n");
230
231 {
232
233 __jamon_innerUnit__hits_tmpl(jamonWriter, bc);
234 }
235
236 jamonWriter.write("\n\n");
237
238 if (bucketCache )
239 {
240
241 jamonWriter.write("\n <tr>\n <td>Hits per Second</td>\n <td>");
242
243 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bucketCacheStats.getIOHitsPerSecond()), jamonWriter);
244
245 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>");
246
247 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bucketCacheStats.getIOTimePerHit()), jamonWriter);
248
249 jamonWriter.write("</td>\n <td>Time per cache hit</td>\n </tr>\n");
250 }
251
252 jamonWriter.write("\n</table>\n<p>View block cache <a href=\"?format=json&bcn=");
253
254 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
255
256 jamonWriter.write("\">as JSON</a> | Block cache <a href=\"?format=json&bcn=");
257
258 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(name), jamonWriter);
259
260 jamonWriter.write("&bcv=file\">as JSON by file</a></p>\n");
261
262
263 cbsbf = null;
264
265 }
266
267
268
269 private void __jamon_innerUnit__bc_stats(final java.io.Writer jamonWriter, final CacheConfig cacheConfig)
270 throws java.io.IOException
271 {
272
273 if (cacheConfig == null || cacheConfig.getBlockCache() == null )
274 {
275
276 jamonWriter.write("\n<p>CacheConfig is null</p>\n");
277 }
278
279 else
280 {
281
282 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>");
283
284 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cacheConfig.getBlockCache().getCurrentSize(),
285 "B", 1)), jamonWriter);
286
287 jamonWriter.write("</td>\n <td>Current size of block cache in use (bytes)</td>\n </tr>\n <tr>\n <td>Free</td>\n <td>");
288
289 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(TraditionalBinaryPrefix.long2String(cacheConfig.getBlockCache().getFreeSize(),
290 "B", 1)), jamonWriter);
291
292 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>");
293
294 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", cacheConfig.getBlockCache().getBlockCount())), jamonWriter);
295
296 jamonWriter.write("</td>\n <td>Number of blocks in block cache</td>\n </tr>\n ");
297
298 {
299
300 __jamon_innerUnit__evictions_tmpl(jamonWriter, cacheConfig.getBlockCache());
301 }
302
303 jamonWriter.write("\n ");
304
305 {
306
307 __jamon_innerUnit__hits_tmpl(jamonWriter, cacheConfig.getBlockCache());
308 }
309
310 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");
311 }
312
313 jamonWriter.write("\n");
314 }
315
316
317
318 private void __jamon_innerUnit__bc_config(final java.io.Writer jamonWriter, final CacheConfig cacheConfig)
319 throws java.io.IOException
320 {
321
322 if (cacheConfig == null )
323 {
324
325 jamonWriter.write("\n<p>CacheConfig is null</p>\n");
326 }
327
328 else
329 {
330
331 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>");
332
333 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataOnRead()), jamonWriter);
334
335 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>");
336
337 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataOnWrite()), jamonWriter);
338
339 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>");
340
341 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheIndexesOnWrite()), jamonWriter);
342
343 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>");
344
345 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheBloomsOnWrite()), jamonWriter);
346
347 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>");
348
349 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldEvictOnClose()), jamonWriter);
350
351 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>");
352
353 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldCacheDataCompressed()), jamonWriter);
354
355 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>");
356
357 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(cacheConfig.shouldPrefetchOnOpen()), jamonWriter);
358
359 jamonWriter.write("</td>\n <td>True if blocks are prefetched into cache on open</td>\n </tr>\n</table>\n");
360 }
361
362 jamonWriter.write("\n");
363 }
364
365
366
367 private void __jamon_innerUnit__bc_baseInfo(final java.io.Writer jamonWriter, final CacheConfig cacheConfig, final String bcUrl, final String bcName)
368 throws java.io.IOException
369 {
370
371
372 BlockCache bc = cacheConfig == null? null: cacheConfig.getBlockCache();
373 BlockCache [] bcs = bc == null? null: bc.getBlockCaches();
374 String bcl1Url = null;
375 String bcl1Name = null;
376 String bcl2Url = null;
377 String bcl2Name = null;
378 if (bcs != null) {
379 BlockCache bcl1 = bcs[0];
380 if (bcl1 != null) {
381 bcl1Url = "http://hbase.apache.org/devapidocs/" + bcl1.getClass().getName().replaceAll("\\.", "/") + ".html";
382 bcl1Name = bcl1.getClass().getSimpleName();
383 }
384 if (bcs.length == 2) {
385 BlockCache bcl2 = bcs[1];
386 bcl2Url = "http://hbase.apache.org/devapidocs/" + bcl2.getClass().getName().replaceAll("\\.", "/") + ".html";
387 bcl2Name = bcl2.getClass().getSimpleName();
388 }
389 }
390
391
392 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=\"");
393
394 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcUrl), jamonWriter);
395
396 jamonWriter.write("\">");
397
398 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(bcName), jamonWriter);
399
400 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");
401 }
402
403
404
405 private void __jamon_innerUnit__evictions_tmpl(final java.io.Writer jamonWriter, final BlockCache bc)
406 throws java.io.IOException
407 {
408
409
410 AgeSnapshot ageAtEvictionSnapshot = bc.getStats().getAgeAtEvictionSnapshot();
411
412 double mean = ageAtEvictionSnapshot.getMean();
413
414
415 jamonWriter.write("<tr>\n <td>Evicted</td>\n <td>");
416
417 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getEvictedCount())), jamonWriter);
418
419 jamonWriter.write("</td>\n <td>The total number of blocks evicted</td>\n </tr>\n <tr>\n <td>Evictions</td>\n <td>");
420
421 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getEvictionCount())), jamonWriter);
422
423 jamonWriter.write("</td>\n <td>The total number of times an eviction has occurred</td>\n </tr>\n");
424
425 if (mean > 0 )
426 {
427
428 jamonWriter.write("\n <tr>\n <td>Mean</td>\n <td>");
429
430 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", (long)(ageAtEvictionSnapshot.getMean()/(1000000 * 1000)))), jamonWriter);
431
432 jamonWriter.write("</td>\n <td>Mean age of Blocks at eviction time (seconds)</td>\n </tr>\n");
433 }
434
435 jamonWriter.write("\n");
436 }
437
438
439
440 private void __jamon_innerUnit__hits_tmpl(final java.io.Writer jamonWriter, final BlockCache bc)
441 throws java.io.IOException
442 {
443
444 jamonWriter.write("<tr>\n <td>Hits</td>\n <td>");
445
446 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getHitCount())), jamonWriter);
447
448 jamonWriter.write("</td>\n <td>Number requests that were cache hits</td>\n </tr>\n <tr>\n <td>Hits Caching</td>\n <td>");
449
450 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getHitCachingCount())), jamonWriter);
451
452 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>");
453
454 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getMissCount())), jamonWriter);
455
456 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>");
457
458 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,d", bc.getStats().getMissCount())), jamonWriter);
459
460 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>");
461
462 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf(String.format("%,.2f", bc.getStats().getHitRatio() * 100)), jamonWriter);
463
464 org.jamon.escaping.Escaping.HTML.write(org.jamon.emit.StandardEmitter.valueOf("%"), jamonWriter);
465
466 jamonWriter.write("</td>\n <td>Hit Count divided by total requests count</td>\n </tr>\n\n");
467 }
468
469
470 }