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