001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.regionserver;
019
020import org.apache.hadoop.hbase.metrics.BaseSource;
021import org.apache.hadoop.hbase.metrics.JvmPauseMonitorSource;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * Interface for classes that expose metrics about the regionserver.
026 */
027@InterfaceAudience.Private
028public interface MetricsRegionServerSource extends BaseSource, JvmPauseMonitorSource {
029
030  /**
031   * The name of the metrics
032   */
033  String METRICS_NAME = "Server";
034
035  /**
036   * The name of the metrics context that metrics will be under.
037   */
038  String METRICS_CONTEXT = "regionserver";
039
040  /**
041   * Description
042   */
043  String METRICS_DESCRIPTION = "Metrics about HBase RegionServer";
044
045  /**
046   * The name of the metrics context that metrics will be under in jmx
047   */
048  String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
049
050  /**
051   * Update the Put time histogram
052   * @param t time it took
053   */
054  void updatePut(long t);
055
056  /**
057   * Update the PutBatch time histogram if a batch contains a Put op
058   * @param t time it took
059   */
060  void updatePutBatch(long t);
061
062  /**
063   * Update the Delete time histogram
064   * @param t time it took
065   */
066  void updateDelete(long t);
067
068  /**
069   * Update the Delete time histogram if a batch contains a delete op
070   * @param t time it took
071   */
072  void updateDeleteBatch(long t);
073
074  /**
075   * Update checkAndDelete histogram
076   * @param t time it took
077   */
078  void updateCheckAndDelete(long t);
079
080  /**
081   * Update checkAndPut histogram
082   * @param t time it took
083   */
084  void updateCheckAndPut(long t);
085
086  /**
087   * Update checkAndMutate histogram
088   * @param time              time it took
089   * @param blockBytesScanned how many block bytes were scanned for the check portion of the request
090   */
091  void updateCheckAndMutate(long time, long blockBytesScanned);
092
093  /**
094   * Update the Get time histogram .
095   * @param time              time it took
096   * @param blockBytesScanned how many block bytes were scanned for the request
097   */
098  void updateGet(long time, long blockBytesScanned);
099
100  /**
101   * Update the Increment time histogram.
102   * @param time              time it took
103   * @param blockBytesScanned how many block bytes were scanned fetching the current value to
104   *                          increment
105   */
106  void updateIncrement(long time, long blockBytesScanned);
107
108  /**
109   * Update the Append time histogram.
110   * @param time              time it took
111   * @param blockBytesScanned how many block bytes were scanned fetching the current value to append
112   */
113  void updateAppend(long time, long blockBytesScanned);
114
115  /**
116   * Update the Replay time histogram.
117   * @param t time it took
118   */
119  void updateReplay(long t);
120
121  /**
122   * Update the scan metrics.
123   * @param time              response time of scan
124   * @param responseCellSize  size of the scan resposne
125   * @param blockBytesScanned size of block bytes scanned to retrieve the response
126   */
127  void updateScan(long time, long responseCellSize, long blockBytesScanned);
128
129  /**
130   * Increment the number of slow Puts that have happened.
131   */
132  void incrSlowPut();
133
134  /**
135   * Increment the number of slow Deletes that have happened.
136   */
137  void incrSlowDelete();
138
139  /**
140   * Increment the number of slow Gets that have happened.
141   */
142  void incrSlowGet();
143
144  /**
145   * Increment the number of slow Increments that have happened.
146   */
147  void incrSlowIncrement();
148
149  /**
150   * Increment the number of slow Appends that have happened.
151   */
152  void incrSlowAppend();
153
154  /**
155   * Increment number of a requested splits
156   */
157  void incrSplitRequest();
158
159  /**
160   * Update the flush time histogram
161   * @param t time it took, in milliseconds
162   */
163  void updateFlushTime(long t);
164
165  /**
166   * Update the flush memstore size histogram
167   * @param bytes the number of bytes in the memstore
168   */
169  void updateFlushMemStoreSize(long bytes);
170
171  /**
172   * Update the flush output file size histogram
173   * @param bytes the number of bytes in the output file
174   */
175  void updateFlushOutputSize(long bytes);
176
177  /**
178   * Update the compaction time histogram, both major and minor
179   * @param isMajor whether compaction is a major compaction
180   * @param t       time it took, in milliseconds
181   */
182  void updateCompactionTime(boolean isMajor, long t);
183
184  /**
185   * Update the compaction input number of files histogram
186   * @param isMajor whether compaction is a major compaction
187   * @param c       number of files
188   */
189  void updateCompactionInputFileCount(boolean isMajor, long c);
190
191  /**
192   * Update the compaction total input file size histogram
193   * @param isMajor whether compaction is a major compaction
194   * @param bytes   the number of bytes of the compaction input file
195   */
196  void updateCompactionInputSize(boolean isMajor, long bytes);
197
198  /**
199   * Update the compaction output number of files histogram
200   * @param isMajor whether compaction is a major compaction
201   * @param c       number of files
202   */
203  void updateCompactionOutputFileCount(boolean isMajor, long c);
204
205  /**
206   * Update the compaction total output file size
207   * @param isMajor whether compaction is a major compaction
208   * @param bytes   the number of bytes of the compaction input file
209   */
210  void updateCompactionOutputSize(boolean isMajor, long bytes);
211
212  void incrScannerLeaseExpired();
213
214  // Strings used for exporting to metrics system.
215  String REGION_COUNT = "regionCount";
216  String REGION_COUNT_DESC = "Number of regions";
217  String STORE_COUNT = "storeCount";
218  String STORE_COUNT_DESC = "Number of Stores";
219  String WALFILE_COUNT = "hlogFileCount";
220  String WALFILE_COUNT_DESC = "Number of WAL Files";
221  String WALFILE_SIZE = "hlogFileSize";
222  String WALFILE_SIZE_DESC = "Size of all WAL Files";
223  String STOREFILE_COUNT = "storeFileCount";
224  String STOREFILE_COUNT_DESC = "Number of Store Files";
225  String STORE_REF_COUNT = "storeRefCount";
226  String STORE_REF_COUNT_DESC = "Store reference count";
227  String MAX_COMPACTED_STORE_FILE_REF_COUNT = "maxCompactedStoreFileRefCount";
228  String MEMSTORE_SIZE = "memStoreSize";
229  String MEMSTORE_SIZE_DESC = "Size of the memstore";
230  String MEMSTORE_HEAP_SIZE = "memStoreHeapSize";
231  String MEMSTORE_HEAP_SIZE_DESC = "On-heap Size of the memstore";
232  String MEMSTORE_OFFHEAP_SIZE = "memStoreOffHeapSize";
233  String MEMSTORE_OFFHEAP_SIZE_DESC = "Off-heap Size of the memstore";
234  String STOREFILE_SIZE = "storeFileSize";
235  String STOREFILE_SIZE_GROWTH_RATE = "storeFileSizeGrowthRate";
236  String MAX_STORE_FILE_AGE = "maxStoreFileAge";
237  String MIN_STORE_FILE_AGE = "minStoreFileAge";
238  String AVG_STORE_FILE_AGE = "avgStoreFileAge";
239  String NUM_REFERENCE_FILES = "numReferenceFiles";
240  String MAX_STORE_FILE_AGE_DESC = "Max age of store files hosted on this RegionServer";
241  String MIN_STORE_FILE_AGE_DESC = "Min age of store files hosted on this RegionServer";
242  String AVG_STORE_FILE_AGE_DESC = "Average age of store files hosted on this RegionServer";
243  String NUM_REFERENCE_FILES_DESC = "Number of reference file on this RegionServer";
244  String STOREFILE_SIZE_DESC = "Size of storefiles being served.";
245  String STOREFILE_SIZE_GROWTH_RATE_DESC =
246    "Bytes per second by which the size of storefiles being served grows.";
247  String TOTAL_REQUEST_COUNT = "totalRequestCount";
248  String TOTAL_REQUEST_COUNT_DESC =
249    "Total number of requests this RegionServer has answered; increments the count once for "
250      + "EVERY access whether an admin operation, a Scan, a Put or Put of 1M rows, or a Get "
251      + "of a non-existent row";
252  String TOTAL_ROW_ACTION_REQUEST_COUNT = "totalRowActionRequestCount";
253  String TOTAL_ROW_ACTION_REQUEST_COUNT_DESC =
254    "Total number of region requests this RegionServer has answered; counts by row-level "
255      + "action at the RPC Server (Sums 'readRequestsCount' and 'writeRequestsCount'); counts"
256      + "once per access whether a Put of 1M rows or a Get that returns 1M Results";
257  String READ_REQUEST_COUNT = "readRequestCount";
258  String FILTERED_READ_REQUEST_COUNT = "filteredReadRequestCount";
259  String FILTERED_READ_REQUEST_COUNT_DESC =
260    "Number of read requests this region server has answered.";
261  String READ_REQUEST_COUNT_DESC =
262    "Number of read requests with non-empty Results that this RegionServer has answered.";
263  String READ_REQUEST_RATE_PER_SECOND = "readRequestRatePerSecond";
264  String READ_REQUEST_RATE_DESC =
265    "Rate of answering the read requests by this region server per second.";
266  String CP_REQUEST_COUNT = "cpRequestCount";
267  String CP_REQUEST_COUNT_DESC =
268    "Number of coprocessor service requests this region server has answered.";
269  String WRITE_REQUEST_COUNT = "writeRequestCount";
270  String WRITE_REQUEST_COUNT_DESC = "Number of mutation requests this RegionServer has answered.";
271  String WRITE_REQUEST_RATE_PER_SECOND = "writeRequestRatePerSecond";
272  String WRITE_REQUEST_RATE_DESC =
273    "Rate of answering the mutation requests by this region server per second.";
274  String CHECK_MUTATE_FAILED_COUNT = "checkMutateFailedCount";
275  String CHECK_MUTATE_FAILED_COUNT_DESC =
276    "Number of Check and Mutate calls that failed the checks.";
277  String CHECK_MUTATE_PASSED_COUNT = "checkMutatePassedCount";
278  String CHECK_MUTATE_PASSED_COUNT_DESC =
279    "Number of Check and Mutate calls that passed the checks.";
280  String STOREFILE_INDEX_SIZE = "storeFileIndexSize";
281  String STOREFILE_INDEX_SIZE_DESC = "Size of indexes in storefiles on disk.";
282  String STATIC_INDEX_SIZE = "staticIndexSize";
283  String STATIC_INDEX_SIZE_DESC = "Uncompressed size of the static indexes.";
284  String STATIC_BLOOM_SIZE = "staticBloomSize";
285  String STATIC_BLOOM_SIZE_DESC = "Uncompressed size of the static bloom filters.";
286
287  String BLOOM_FILTER_REQUESTS_COUNT = "bloomFilterRequestsCount";
288  String BLOOM_FILTER_REQUESTS_COUNT_DESC = "Count of requests to bloom filters.";
289
290  String BLOOM_FILTER_NEGATIVE_RESULTS_COUNT = "bloomFilterNegativeResultsCount";
291  String BLOOM_FILTER_NEGATIVE_RESULTS_COUNT_DESC =
292    "Count of bloom filter requests which returned a negative result.";
293
294  String BLOOM_FILTER_ELIGIBLE_REQUESTS_COUNT = "bloomFilterEligibleRequestsCount";
295  String BLOOM_FILTER_ELIGIBLE_REQUESTS_COUNT_DESC =
296    "Count of requests which could have used bloom filters but didn't because they weren't configured or loaded";
297
298  String NUMBER_OF_MUTATIONS_WITHOUT_WAL = "mutationsWithoutWALCount";
299  String NUMBER_OF_MUTATIONS_WITHOUT_WAL_DESC =
300    "Number of mutations that have been sent by clients with the write ahead logging turned off.";
301  String DATA_SIZE_WITHOUT_WAL = "mutationsWithoutWALSize";
302  String DATA_SIZE_WITHOUT_WAL_DESC =
303    "Size of data that has been sent by clients with the write ahead logging turned off.";
304  String PERCENT_FILES_LOCAL = "percentFilesLocal";
305  String PERCENT_FILES_LOCAL_DESC =
306    "The percent of HFiles that are stored on the local hdfs data node. If not using "
307      + "region replicas, this should equal percentFilesLocalPrimaryRegions";
308  String PERCENT_FILES_LOCAL_PRIMARY_REGIONS = "percentFilesLocalPrimaryRegions";
309  String PERCENT_FILES_LOCAL_PRIMARY_REGIONS_DESC =
310    "The percent of HFiles used by primary regions that are stored on the local hdfs data node. "
311      + "This is the category of locality that you want to reach 100% when using region replicas";
312  String PERCENT_FILES_LOCAL_SECONDARY_REGIONS = "percentFilesLocalSecondaryRegions";
313  String PERCENT_FILES_LOCAL_SECONDARY_REGIONS_DESC =
314    "The percent of HFiles used by secondary regions that are stored on the local hdfs data node. "
315      + "This is not likely to reach 100%";
316  String SPLIT_QUEUE_LENGTH = "splitQueueLength";
317  String SPLIT_QUEUE_LENGTH_DESC = "Length of the queue for splits.";
318  String COMPACTION_QUEUE_LENGTH = "compactionQueueLength";
319  String LARGE_COMPACTION_QUEUE_LENGTH = "largeCompactionQueueLength";
320  String SMALL_COMPACTION_QUEUE_LENGTH = "smallCompactionQueueLength";
321  String COMPACTION_QUEUE_LENGTH_DESC = "Length of the queue for compactions.";
322  String LARGE_COMPACTION_QUEUE_LENGTH_DESC = "Length of the queue for compactions with input size "
323    + "larger than throttle threshold (2.5GB by default)";
324  String SMALL_COMPACTION_QUEUE_LENGTH_DESC = "Length of the queue for compactions with input size "
325    + "smaller than throttle threshold (2.5GB by default)";
326  String FLUSH_QUEUE_LENGTH = "flushQueueLength";
327  String FLUSH_QUEUE_LENGTH_DESC = "Length of the queue for region flushes";
328  String BLOCK_CACHE_FREE_SIZE = "blockCacheFreeSize";
329  String BLOCK_CACHE_FREE_DESC = "Size of the block cache that is not occupied.";
330  String BLOCK_CACHE_COUNT = "blockCacheCount";
331  String BLOCK_CACHE_COUNT_DESC = "Number of block in the block cache.";
332  String BLOCK_CACHE_DATA_BLOCK_COUNT = "blockCacheDataBlockCount";
333  String BLOCK_CACHE_DATA_BLOCK_COUNT_DESC = "Number of DATA block in the block cache.";
334  String BLOCK_CACHE_SIZE = "blockCacheSize";
335  String BLOCK_CACHE_SIZE_DESC = "Size of the block cache.";
336  String BLOCK_CACHE_HIT_COUNT = "blockCacheHitCount";
337  String BLOCK_CACHE_HIT_COUNT_DESC = "Count of the hit on the block cache.";
338  String BLOCK_CACHE_PRIMARY_HIT_COUNT = "blockCacheHitCountPrimary";
339  String BLOCK_CACHE_PRIMARY_HIT_COUNT_DESC = "Count of hit on primary replica in the block cache.";
340  String BLOCK_CACHE_HIT_CACHING_COUNT = "blockCacheHitCachingCount";
341  String BLOCK_CACHE_HIT_CACHING_COUNT_DESC =
342    "Count of the hit on the block cache, for cacheable requests.";
343  String BLOCK_CACHE_MISS_COUNT = "blockCacheMissCount";
344  String BLOCK_COUNT_MISS_COUNT_DESC =
345    "Number of requests for a block that missed the block cache.";
346  String BLOCK_CACHE_PRIMARY_MISS_COUNT = "blockCacheMissCountPrimary";
347  String BLOCK_COUNT_PRIMARY_MISS_COUNT_DESC =
348    "Number of requests for a block of primary replica that missed the block cache.";
349  String BLOCK_CACHE_MISS_CACHING_COUNT = "blockCacheMissCachingCount";
350  String BLOCK_COUNT_MISS_CACHING_COUNT_DESC =
351    "Number of requests for a block that missed the block cache, for cacheable requests.";
352  String BLOCK_CACHE_EVICTION_COUNT = "blockCacheEvictionCount";
353  String BLOCK_CACHE_EVICTION_COUNT_DESC =
354    "Count of the number of blocks evicted from the block cache."
355      + "(Not including blocks evicted because of HFile removal)";
356  String BLOCK_CACHE_PRIMARY_EVICTION_COUNT = "blockCacheEvictionCountPrimary";
357  String BLOCK_CACHE_PRIMARY_EVICTION_COUNT_DESC =
358    "Count of the number of blocks evicted from primary replica in the block cache.";
359  String BLOCK_CACHE_HIT_PERCENT = "blockCacheCountHitPercent";
360  String BLOCK_CACHE_HIT_PERCENT_DESC = "Percent of block cache requests that are hits";
361  String BLOCK_CACHE_EXPRESS_HIT_PERCENT = "blockCacheExpressHitPercent";
362  String BLOCK_CACHE_EXPRESS_HIT_PERCENT_DESC =
363    "The percent of the time that requests with the cache turned on hit the cache.";
364  String BLOCK_CACHE_FAILED_INSERTION_COUNT = "blockCacheFailedInsertionCount";
365  String BLOCK_CACHE_FAILED_INSERTION_COUNT_DESC =
366    "Number of times that a block cache " + "insertion failed. Usually due to size restrictions.";
367  String BLOCK_CACHE_DATA_MISS_COUNT = "blockCacheDataMissCount";
368  String BLOCK_CACHE_ENCODED_DATA_MISS_COUNT = "blockCacheEncodedDataMissCount";
369  String BLOCK_CACHE_LEAF_INDEX_MISS_COUNT = "blockCacheLeafIndexMissCount";
370  String BLOCK_CACHE_BLOOM_CHUNK_MISS_COUNT = "blockCacheBloomChunkMissCount";
371  String BLOCK_CACHE_META_MISS_COUNT = "blockCacheMetaMissCount";
372  String BLOCK_CACHE_ROOT_INDEX_MISS_COUNT = "blockCacheRootIndexMissCount";
373  String BLOCK_CACHE_INTERMEDIATE_INDEX_MISS_COUNT = "blockCacheIntermediateIndexMissCount";
374  String BLOCK_CACHE_FILE_INFO_MISS_COUNT = "blockCacheFileInfoMissCount";
375  String BLOCK_CACHE_GENERAL_BLOOM_META_MISS_COUNT = "blockCacheGeneralBloomMetaMissCount";
376  String BLOCK_CACHE_DELETE_FAMILY_BLOOM_MISS_COUNT = "blockCacheDeleteFamilyBloomMissCount";
377  String BLOCK_CACHE_TRAILER_MISS_COUNT = "blockCacheTrailerMissCount";
378  String BLOCK_CACHE_DATA_HIT_COUNT = "blockCacheDataHitCount";
379  String BLOCK_CACHE_ENCODED_DATA_HIT_COUNT = "blockCacheEncodedDataHitCount";
380  String BLOCK_CACHE_LEAF_INDEX_HIT_COUNT = "blockCacheLeafIndexHitCount";
381  String BLOCK_CACHE_BLOOM_CHUNK_HIT_COUNT = "blockCacheBloomChunkHitCount";
382  String BLOCK_CACHE_META_HIT_COUNT = "blockCacheMetaHitCount";
383  String BLOCK_CACHE_ROOT_INDEX_HIT_COUNT = "blockCacheRootIndexHitCount";
384  String BLOCK_CACHE_INTERMEDIATE_INDEX_HIT_COUNT = "blockCacheIntermediateIndexHitCount";
385  String BLOCK_CACHE_FILE_INFO_HIT_COUNT = "blockCacheFileInfoHitCount";
386  String BLOCK_CACHE_GENERAL_BLOOM_META_HIT_COUNT = "blockCacheGeneralBloomMetaHitCount";
387  String BLOCK_CACHE_DELETE_FAMILY_BLOOM_HIT_COUNT = "blockCacheDeleteFamilyBloomHitCount";
388  String BLOCK_CACHE_TRAILER_HIT_COUNT = "blockCacheTrailerHitCount";
389  String L1_CACHE_FREE_SIZE = "l1CacheFreeSize";
390  String L1_CACHE_FREE_SIZE_DESC = "Amount of free bytes in the L1 cache";
391  String L1_CACHE_SIZE = "l1CacheSize";
392  String L1_CACHE_SIZE_DESC = "Size of the L1 cache in bytes";
393  String L1_CACHE_COUNT = "l1CacheCount";
394  String L1_CACHE_COUNT_DESC = "Count of blocks in the L1 cache";
395  String L1_CACHE_EVICTION_COUNT = "l1CacheEvictionCount";
396  String L1_CACHE_EVICTION_COUNT_DESC = "Count of blocks evicted from the L1 cache";
397
398  String L1_CACHE_HIT_COUNT = "l1CacheHitCount";
399  String L1_CACHE_HIT_COUNT_DESC = "L1 cache hit count.";
400  String L1_CACHE_HIT_CAGHING_COUNT = "l1CacheHitCachingCount";
401  String L1_CACHE_HIT_CAGHING_COUNT_DESC =
402    "Count of the hit on the L1 cache, for cacheable requests";
403  String L1_CACHE_MISS_COUNT = "l1CacheMissCount";
404  String L1_CACHE_MISS_COUNT_DESC = "L1 cache miss count.";
405  String L1_CACHE_MISS_CACHING_COUNT = "l1CacheMissCachingCount";
406  String L1_CACHE_MISS_CACHING_COUNT_DESC =
407    "Count of the misses on the L1 cache, for cacheable requests";
408  String L1_CACHE_HIT_RATIO = "l1CacheHitRatio";
409  String L1_CACHE_HIT_RATIO_DESC = "L1 cache hit ratio.";
410  String L1_CACHE_HIT_CACHING_RATIO = "l1CacheHitCachingRatio";
411  String L1_CACHE_HIT_CACHING_RATIO_DESC = "Hit Caching ratio of L1 cache";
412  String L1_CACHE_MISS_RATIO = "l1CacheMissRatio";
413  String L1_CACHE_MISS_RATIO_DESC = "L1 cache miss ratio.";
414  String L1_CACHE_MISS_CACHING_RATIO = "l1CacheMissCachingRatio";
415  String L1_CACHE_MISS_CACHING_RATIO_DESC = "Miss Caching ratio of L1 cache";
416  String L2_CACHE_FREE_SIZE = "l2CacheFreeSize";
417  String L2_CACHE_FREE_SIZE_DESC = "Amount of free bytes in the L2 cache";
418  String L2_CACHE_SIZE = "l2CacheSize";
419  String L2_CACHE_SIZE_DESC = "Size of the L2 cache in bytes";
420  String L2_CACHE_COUNT = "l2CacheCount";
421  String L2_CACHE_COUNT_DESC = "Count of blocks in the L2 cache";
422  String L2_CACHE_EVICTION_COUNT = "l2CacheEvictionCount";
423  String L2_CACHE_EVICTION_COUNT_DESC = "Count of blocks evicted from the L2 cache";
424  String L2_CACHE_HIT_COUNT = "l2CacheHitCount";
425  String L2_CACHE_HIT_COUNT_DESC = "L2 cache hit count.";
426  String L2_CACHE_HIT_CACHING_COUNT = "l2CacheHitCachingCount";
427  String L2_CACHE_HIT_CACHING_COUNT_DESC =
428    "Count of the hit on the L2 cache, for cacheable requests";
429  String L2_CACHE_MISS_COUNT = "l2CacheMissCount";
430  String L2_CACHE_MISS_COUNT_DESC = "L2 cache miss count.";
431  String L2_CACHE_MISS_CACHING_COUNT = "l2CacheMissCachingCount";
432  String L2_CACHE_MISS_CACHING_COUNT_DESC =
433    "Count of the misses on the L2 cache, for cacheable requests";
434  String L2_CACHE_HIT_RATIO = "l2CacheHitRatio";
435  String L2_CACHE_HIT_RATIO_DESC = "L2 cache hit ratio.";
436  String L2_CACHE_HIT_CACHING_RATIO = "l2CacheHitCachingRatio";
437  String L2_CACHE_HIT_CACHING_RATIO_DESC = "Hit Caching ratio of L2 cache";
438  String L2_CACHE_MISS_RATIO = "l2CacheMissRatio";
439  String L2_CACHE_MISS_RATIO_DESC = "L2 cache miss ratio.";
440  String L2_CACHE_MISS_CACHING_RATIO = "l2CacheMissCachingRatio";
441  String L2_CACHE_MISS_CACHING_RATIO_DESC = "Miss Caching ratio of L2 cache";
442  String RS_START_TIME_NAME = "regionServerStartTime";
443  String ZOOKEEPER_QUORUM_NAME = "zookeeperQuorum";
444  String SERVER_NAME_NAME = "serverName";
445  String CLUSTER_ID_NAME = "clusterId";
446  String RS_START_TIME_DESC = "RegionServer Start Time";
447  String ZOOKEEPER_QUORUM_DESC = "ZooKeeper Quorum";
448  String SERVER_NAME_DESC = "Server Name";
449  String CLUSTER_ID_DESC = "Cluster Id";
450  String UPDATES_BLOCKED_TIME = "updatesBlockedTime";
451  String UPDATES_BLOCKED_DESC =
452    "Number of MS updates have been blocked so that the memstore can be flushed.";
453  String DELETE_KEY = "delete";
454  String CHECK_AND_DELETE_KEY = "checkAndDelete";
455  String CHECK_AND_PUT_KEY = "checkAndPut";
456  String CHECK_AND_MUTATE_KEY = "checkAndMutate";
457  String DELETE_BATCH_KEY = "deleteBatch";
458  String GET_SIZE_KEY = "getSize";
459  String GET_KEY = "get";
460  String INCREMENT_KEY = "increment";
461  String PUT_KEY = "put";
462  String PUT_BATCH_KEY = "putBatch";
463  String APPEND_KEY = "append";
464  String REPLAY_KEY = "replay";
465  String SCAN_KEY = "scan";
466  String SCAN_SIZE_KEY = "scanSize";
467  String SCAN_TIME_KEY = "scanTime";
468
469  String BLOCK_BYTES_SCANNED_KEY = "blockBytesScannedCount";
470  String BLOCK_BYTES_SCANNED_DESC = "Count of block bytes scanned by read requests";
471  String GET_BLOCK_BYTES_SCANNED_KEY = "getBlockBytesScanned";
472  String SCAN_BLOCK_BYTES_SCANNED_KEY = "scanBlockBytesScanned";
473  String CHECK_AND_MUTATE_BLOCK_BYTES_SCANNED_KEY = "checkAndMutateBlockBytesScanned";
474  String INCREMENT_BLOCK_BYTES_SCANNED_KEY = "incrementBlockBytesScanned";
475  String APPEND_BLOCK_BYTES_SCANNED_KEY = "appendBlockBytesScanned";
476  String SLOW_PUT_KEY = "slowPutCount";
477  String SLOW_GET_KEY = "slowGetCount";
478  String SLOW_DELETE_KEY = "slowDeleteCount";
479  String SLOW_INCREMENT_KEY = "slowIncrementCount";
480  String SLOW_APPEND_KEY = "slowAppendCount";
481  String SLOW_PUT_DESC = "The number of batches containing puts that took over 1000ms to complete";
482  String SLOW_DELETE_DESC =
483    "The number of batches containing delete(s) that took over 1000ms to complete";
484  String SLOW_GET_DESC = "The number of Gets that took over 1000ms to complete";
485  String SLOW_INCREMENT_DESC = "The number of Increments that took over 1000ms to complete";
486  String SLOW_APPEND_DESC = "The number of Appends that took over 1000ms to complete";
487
488  String FLUSHED_CELLS = "flushedCellsCount";
489  String FLUSHED_CELLS_DESC = "The number of cells flushed to disk";
490  String FLUSHED_CELLS_SIZE = "flushedCellsSize";
491  String FLUSHED_CELLS_SIZE_DESC = "The total amount of data flushed to disk, in bytes";
492  String COMPACTED_CELLS = "compactedCellsCount";
493  String COMPACTED_CELLS_DESC = "The number of cells processed during minor compactions";
494  String COMPACTED_CELLS_SIZE = "compactedCellsSize";
495  String COMPACTED_CELLS_SIZE_DESC =
496    "The total amount of data processed during minor compactions, in bytes";
497  String MAJOR_COMPACTED_CELLS = "majorCompactedCellsCount";
498  String MAJOR_COMPACTED_CELLS_DESC = "The number of cells processed during major compactions";
499  String MAJOR_COMPACTED_CELLS_SIZE = "majorCompactedCellsSize";
500  String MAJOR_COMPACTED_CELLS_SIZE_DESC =
501    "The total amount of data processed during major compactions, in bytes";
502  String CELLS_COUNT_COMPACTED_TO_MOB = "cellsCountCompactedToMob";
503  String CELLS_COUNT_COMPACTED_TO_MOB_DESC = "The number of cells moved to mob during compaction";
504  String CELLS_COUNT_COMPACTED_FROM_MOB = "cellsCountCompactedFromMob";
505  String CELLS_COUNT_COMPACTED_FROM_MOB_DESC =
506    "The number of cells moved from mob during compaction";
507  String CELLS_SIZE_COMPACTED_TO_MOB = "cellsSizeCompactedToMob";
508  String CELLS_SIZE_COMPACTED_TO_MOB_DESC =
509    "The total amount of cells move to mob during compaction, in bytes";
510  String CELLS_SIZE_COMPACTED_FROM_MOB = "cellsSizeCompactedFromMob";
511  String CELLS_SIZE_COMPACTED_FROM_MOB_DESC =
512    "The total amount of cells move from mob during compaction, in bytes";
513  String MOB_FLUSH_COUNT = "mobFlushCount";
514  String MOB_FLUSH_COUNT_DESC = "The number of the flushes in mob-enabled stores";
515  String MOB_FLUSHED_CELLS_COUNT = "mobFlushedCellsCount";
516  String MOB_FLUSHED_CELLS_COUNT_DESC = "The number of mob cells flushed to disk";
517  String MOB_FLUSHED_CELLS_SIZE = "mobFlushedCellsSize";
518  String MOB_FLUSHED_CELLS_SIZE_DESC = "The total amount of mob cells flushed to disk, in bytes";
519  String MOB_SCAN_CELLS_COUNT = "mobScanCellsCount";
520  String MOB_SCAN_CELLS_COUNT_DESC = "The number of scanned mob cells";
521  String MOB_SCAN_CELLS_SIZE = "mobScanCellsSize";
522  String MOB_SCAN_CELLS_SIZE_DESC = "The total amount of scanned mob cells, in bytes";
523  String MOB_FILE_CACHE_ACCESS_COUNT = "mobFileCacheAccessCount";
524  String MOB_FILE_CACHE_ACCESS_COUNT_DESC = "The count of accesses to the mob file cache";
525  String MOB_FILE_CACHE_MISS_COUNT = "mobFileCacheMissCount";
526  String MOB_FILE_CACHE_MISS_COUNT_DESC = "The count of misses to the mob file cache";
527  String MOB_FILE_CACHE_HIT_PERCENT = "mobFileCacheHitPercent";
528  String MOB_FILE_CACHE_HIT_PERCENT_DESC = "The hit percent to the mob file cache";
529  String MOB_FILE_CACHE_EVICTED_COUNT = "mobFileCacheEvictedCount";
530  String MOB_FILE_CACHE_EVICTED_COUNT_DESC = "The number of items evicted from the mob file cache";
531  String MOB_FILE_CACHE_COUNT = "mobFileCacheCount";
532  String MOB_FILE_CACHE_COUNT_DESC = "The count of cached mob files";
533
534  String HEDGED_READS = "hedgedReads";
535  String HEDGED_READS_DESC = "The number of times we started a hedged read";
536  String HEDGED_READ_WINS = "hedgedReadWins";
537  String HEDGED_READ_WINS_DESC =
538    "The number of times we started a hedged read and a hedged read won";
539  String HEDGED_READ_IN_CUR_THREAD = "hedgedReadOpsInCurThread";
540  String HEDGED_READ_IN_CUR_THREAD_DESC = "The number of times we execute a hedged read"
541    + " in current thread as a fallback for task rejection";
542
543  String TOTAL_BYTES_READ = "totalBytesRead";
544  String TOTAL_BYTES_READ_DESC = "The total number of bytes read from HDFS";
545  String LOCAL_BYTES_READ = "localBytesRead";
546  String LOCAL_BYTES_READ_DESC = "The number of bytes read from the local HDFS DataNode";
547  String SHORTCIRCUIT_BYTES_READ = "shortCircuitBytesRead";
548  String SHORTCIRCUIT_BYTES_READ_DESC = "The number of bytes read through HDFS short circuit read";
549  String ZEROCOPY_BYTES_READ = "zeroCopyBytesRead";
550  String ZEROCOPY_BYTES_READ_DESC = "The number of bytes read through HDFS zero copy";
551
552  String BLOCKED_REQUESTS_COUNT = "blockedRequestCount";
553  String BLOCKED_REQUESTS_COUNT_DESC = "The number of blocked requests because of memstore size is "
554    + "larger than blockingMemStoreSize";
555
556  String SPLIT_REQUEST_KEY = "splitRequestCount";
557  String SPLIT_REQUEST_DESC = "Number of splits requested";
558
559  String FLUSH_TIME = "flushTime";
560  String FLUSH_TIME_DESC = "Histogram for the time in millis for memstore flush";
561  String FLUSH_MEMSTORE_SIZE = "flushMemstoreSize";
562  String FLUSH_MEMSTORE_SIZE_DESC = "Histogram for number of bytes in the memstore for a flush";
563  String FLUSH_OUTPUT_SIZE = "flushOutputSize";
564  String FLUSH_OUTPUT_SIZE_DESC = "Histogram for number of bytes in the resulting file for a flush";
565  String FLUSHED_OUTPUT_BYTES = "flushedOutputBytes";
566  String FLUSHED_OUTPUT_BYTES_DESC = "Total number of bytes written from flush";
567  String FLUSHED_MEMSTORE_BYTES = "flushedMemstoreBytes";
568  String FLUSHED_MEMSTORE_BYTES_DESC = "Total number of bytes of cells in memstore from flush";
569
570  String COMPACTION_TIME = "compactionTime";
571  String COMPACTION_TIME_DESC =
572    "Histogram for the time in millis for compaction, both major and minor";
573  String COMPACTION_INPUT_FILE_COUNT = "compactionInputFileCount";
574  String COMPACTION_INPUT_FILE_COUNT_DESC =
575    "Histogram for the compaction input number of files, both major and minor";
576  String COMPACTION_INPUT_SIZE = "compactionInputSize";
577  String COMPACTION_INPUT_SIZE_DESC =
578    "Histogram for the compaction total input file sizes, both major and minor";
579  String COMPACTION_OUTPUT_FILE_COUNT = "compactionOutputFileCount";
580  String COMPACTION_OUTPUT_FILE_COUNT_DESC =
581    "Histogram for the compaction output number of files, both major and minor";
582  String COMPACTION_OUTPUT_SIZE = "compactionOutputSize";
583  String COMPACTION_OUTPUT_SIZE_DESC =
584    "Histogram for the compaction total output file sizes, both major and minor";
585  String COMPACTED_INPUT_BYTES = "compactedInputBytes";
586  String COMPACTED_INPUT_BYTES_DESC =
587    "Total number of bytes that is read for compaction, both major and minor";
588  String COMPACTED_OUTPUT_BYTES = "compactedOutputBytes";
589  String COMPACTED_OUTPUT_BYTES_DESC =
590    "Total number of bytes that is output from compaction, both major and minor";
591
592  String MAJOR_COMPACTION_TIME = "majorCompactionTime";
593  String MAJOR_COMPACTION_TIME_DESC = "Histogram for the time in millis for compaction, major only";
594  String MAJOR_COMPACTION_INPUT_FILE_COUNT = "majorCompactionInputFileCount";
595  String MAJOR_COMPACTION_INPUT_FILE_COUNT_DESC =
596    "Histogram for the compaction input number of files, major only";
597  String MAJOR_COMPACTION_INPUT_SIZE = "majorCompactionInputSize";
598  String MAJOR_COMPACTION_INPUT_SIZE_DESC =
599    "Histogram for the compaction total input file sizes, major only";
600  String MAJOR_COMPACTION_OUTPUT_FILE_COUNT = "majorCompactionOutputFileCount";
601  String MAJOR_COMPACTION_OUTPUT_FILE_COUNT_DESC =
602    "Histogram for the compaction output number of files, major only";
603  String MAJOR_COMPACTION_OUTPUT_SIZE = "majorCompactionOutputSize";
604  String MAJOR_COMPACTION_OUTPUT_SIZE_DESC =
605    "Histogram for the compaction total output file sizes, major only";
606  String MAJOR_COMPACTED_INPUT_BYTES = "majorCompactedInputBytes";
607  String MAJOR_COMPACTED_INPUT_BYTES_DESC =
608    "Total number of bytes that is read for compaction, major only";
609  String MAJOR_COMPACTED_OUTPUT_BYTES = "majorCompactedOutputBytes";
610  String MAJOR_COMPACTED_OUTPUT_BYTES_DESC =
611    "Total number of bytes that is output from compaction, major only";
612
613  String RPC_GET_REQUEST_COUNT = "rpcGetRequestCount";
614  String RPC_GET_REQUEST_COUNT_DESC = "Number of rpc get requests this RegionServer has answered.";
615  String RPC_SCAN_REQUEST_COUNT = "rpcScanRequestCount";
616  String RPC_SCAN_REQUEST_COUNT_DESC =
617    "Number of rpc scan requests this RegionServer has answered.";
618  String RPC_FULL_SCAN_REQUEST_COUNT = "rpcFullScanRequestCount";
619  String RPC_FULL_SCAN_REQUEST_COUNT_DESC =
620    "Number of rpc scan requests that were possible full region scans.";
621  String RPC_MULTI_REQUEST_COUNT = "rpcMultiRequestCount";
622  String RPC_MULTI_REQUEST_COUNT_DESC =
623    "Number of rpc multi requests this RegionServer has answered.";
624  String RPC_MUTATE_REQUEST_COUNT = "rpcMutateRequestCount";
625  String RPC_MUTATE_REQUEST_COUNT_DESC =
626    "Number of rpc mutation requests this RegionServer has answered.";
627  String MAX_STOREFILE_COUNT = "maxStoreFileCount";
628  String MAX_STOREFILE_COUNT_DESC = "Max store file count across all regions";
629  String AVERAGE_REGION_SIZE = "averageRegionSize";
630  String AVERAGE_REGION_SIZE_DESC =
631    "Average region size over the RegionServer including memstore and storefile sizes.";
632
633  /** Metrics for {@link org.apache.hadoop.hbase.io.ByteBuffAllocator} **/
634  String BYTE_BUFF_ALLOCATOR_HEAP_ALLOCATION_BYTES = "ByteBuffAllocatorHeapAllocationBytes";
635  String BYTE_BUFF_ALLOCATOR_HEAP_ALLOCATION_BYTES_DESC =
636    "Bytes of heap allocation from ByteBuffAllocator";
637  String BYTE_BUFF_ALLOCATOR_POOL_ALLOCATION_BYTES = "ByteBuffAllocatorPoolAllocationBytes";
638  String BYTE_BUFF_ALLOCATOR_POOL_ALLOCATION_BYTES_DESC =
639    "Bytes of pool allocation from ByteBuffAllocator";
640  String BYTE_BUFF_ALLOCATOR_HEAP_ALLOCATION_RATIO = "ByteBuffAllocatorHeapAllocationRatio";
641  String BYTE_BUFF_ALLOCATOR_HEAP_ALLOCATION_RATIO_DESC =
642    "Ratio of heap allocation from ByteBuffAllocator, means heapAllocation/totalAllocation";
643  String BYTE_BUFF_ALLOCATOR_TOTAL_BUFFER_COUNT = "ByteBuffAllocatorTotalBufferCount";
644  String BYTE_BUFF_ALLOCATOR_TOTAL_BUFFER_COUNT_DESC = "Total buffer count in ByteBuffAllocator";
645  String BYTE_BUFF_ALLOCATOR_USED_BUFFER_COUNT = "ByteBuffAllocatorUsedBufferCount";
646  String BYTE_BUFF_ALLOCATOR_USED_BUFFER_COUNT_DESC = "Used buffer count in ByteBuffAllocator";
647
648  String ACTIVE_SCANNERS = "activeScanners";
649  String ACTIVE_SCANNERS_DESC = "Gauge of currently active scanners";
650
651  String SCANNER_LEASE_EXPIRED_COUNT = "scannerLeaseExpiredCount";
652  String SCANNER_LEASE_EXPIRED_COUNT_DESC =
653    "Count of scanners which were expired due to scanner lease timeout";
654  String CURRENT_REGION_CACHE_RATIO = "currentRegionCacheRatio";
655  String CURRENT_REGION_CACHE_RATIO_DESC = "The percentage of caching completed for this region.";
656
657  String EXCLUDE_DATA_NODES_COUNT = "excludedDataNodesCount";
658  String EXCLUDE_DATA_NODES_COUNT_DESC =
659    "Count of slow/connect error DataNodes excluded during WAL write operation";
660  String EXCLUDE_DATA_NODES_DETAILS = "excludedDataNodesDetails";
661  String EXCLUDE_DATA_NODES_DETAILS_DESC = "Excluded DataNodes info";
662}