View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.regionserver;
20  
21  import org.apache.hadoop.hbase.metrics.BaseSource;
22  
23  /**
24   * Interface for classes that expose metrics about the regionserver.
25   */
26  public interface MetricsRegionServerSource extends BaseSource {
27  
28    /**
29     * The name of the metrics
30     */
31    String METRICS_NAME = "Server";
32  
33    /**
34     * The name of the metrics context that metrics will be under.
35     */
36    String METRICS_CONTEXT = "regionserver";
37  
38    /**
39     * Description
40     */
41    String METRICS_DESCRIPTION = "Metrics about HBase RegionServer";
42  
43    /**
44     * The name of the metrics context that metrics will be under in jmx
45     */
46    String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
47  
48    /**
49     * Update the Put time histogram
50     *
51     * @param t time it took
52     */
53    void updatePut(long t);
54  
55    /**
56     * Update the Delete time histogram
57     *
58     * @param t time it took
59     */
60    void updateDelete(long t);
61  
62    /**
63     * Update the Get time histogram .
64     *
65     * @param t time it took
66     */
67    void updateGet(long t);
68  
69    /**
70     * Update the Increment time histogram.
71     *
72     * @param t time it took
73     */
74    void updateIncrement(long t);
75  
76    /**
77     * Update the Append time histogram.
78     *
79     * @param t time it took
80     */
81    void updateAppend(long t);
82  
83    /**
84     * Update the Replay time histogram.
85     *
86     * @param t time it took
87     */
88    void updateReplay(long t);
89  
90    /**
91     * Increment the number of slow Puts that have happened.
92     */
93    void incrSlowPut();
94  
95    /**
96     * Increment the number of slow Deletes that have happened.
97     */
98    void incrSlowDelete();
99  
100   /**
101    * Increment the number of slow Gets that have happened.
102    */
103   void incrSlowGet();
104 
105   /**
106    * Increment the number of slow Increments that have happened.
107    */
108   void incrSlowIncrement();
109 
110   /**
111    * Increment the number of slow Appends that have happened.
112    */
113   void incrSlowAppend();
114 
115   /**
116    * Update the split transaction time histogram
117    * @param t time it took, in milliseconds
118    */
119   void updateSplitTime(long t);
120 
121   /**
122    * Increment number of a requested splits
123    */
124   void incrSplitRequest();
125 
126   /**
127    * Increment number of successful splits
128    */
129   void incrSplitSuccess();
130 
131   /**
132    * Update the flush time histogram
133    * @param t time it took, in milliseconds
134    */
135   void updateFlushTime(long t);
136 
137   // Strings used for exporting to metrics system.
138   String REGION_COUNT = "regionCount";
139   String REGION_COUNT_DESC = "Number of regions";
140   String STORE_COUNT = "storeCount";
141   String STORE_COUNT_DESC = "Number of Stores";
142   String WALFILE_COUNT = "hlogFileCount";
143   String WALFILE_COUNT_DESC = "Number of WAL Files";
144   String WALFILE_SIZE = "hlogFileSize";
145   String WALFILE_SIZE_DESC = "Size of all WAL Files";
146   String STOREFILE_COUNT = "storeFileCount";
147   String STOREFILE_COUNT_DESC = "Number of Store Files";
148   String MEMSTORE_SIZE = "memStoreSize";
149   String MEMSTORE_SIZE_DESC = "Size of the memstore";
150   String STOREFILE_SIZE = "storeFileSize";
151   String STOREFILE_SIZE_DESC = "Size of storefiles being served.";
152   String TOTAL_REQUEST_COUNT = "totalRequestCount";
153   String TOTAL_REQUEST_COUNT_DESC =
154       "Total number of requests this RegionServer has answered.";
155   String READ_REQUEST_COUNT = "readRequestCount";
156   String READ_REQUEST_COUNT_DESC =
157       "Number of read requests this region server has answered.";
158   String WRITE_REQUEST_COUNT = "writeRequestCount";
159   String WRITE_REQUEST_COUNT_DESC =
160       "Number of mutation requests this region server has answered.";
161   String CHECK_MUTATE_FAILED_COUNT = "checkMutateFailedCount";
162   String CHECK_MUTATE_FAILED_COUNT_DESC =
163       "Number of Check and Mutate calls that failed the checks.";
164   String CHECK_MUTATE_PASSED_COUNT = "checkMutatePassedCount";
165   String CHECK_MUTATE_PASSED_COUNT_DESC =
166       "Number of Check and Mutate calls that passed the checks.";
167   String STOREFILE_INDEX_SIZE = "storeFileIndexSize";
168   String STOREFILE_INDEX_SIZE_DESC = "Size of indexes in storefiles on disk.";
169   String STATIC_INDEX_SIZE = "staticIndexSize";
170   String STATIC_INDEX_SIZE_DESC = "Uncompressed size of the static indexes.";
171   String STATIC_BLOOM_SIZE = "staticBloomSize";
172   String STATIC_BLOOM_SIZE_DESC =
173       "Uncompressed size of the static bloom filters.";
174   String NUMBER_OF_MUTATIONS_WITHOUT_WAL = "mutationsWithoutWALCount";
175   String NUMBER_OF_MUTATIONS_WITHOUT_WAL_DESC =
176       "Number of mutations that have been sent by clients with the write ahead logging turned off.";
177   String DATA_SIZE_WITHOUT_WAL = "mutationsWithoutWALSize";
178   String DATA_SIZE_WITHOUT_WAL_DESC =
179       "Size of data that has been sent by clients with the write ahead logging turned off.";
180   String PERCENT_FILES_LOCAL = "percentFilesLocal";
181   String PERCENT_FILES_LOCAL_DESC =
182       "The percent of HFiles that are stored on the local hdfs data node.";
183   String SPLIT_QUEUE_LENGTH = "splitQueueLength";
184   String SPLIT_QUEUE_LENGTH_DESC = "Length of the queue for splits.";
185   String COMPACTION_QUEUE_LENGTH = "compactionQueueLength";
186   String LARGE_COMPACTION_QUEUE_LENGTH = "largeCompactionQueueLength";
187   String SMALL_COMPACTION_QUEUE_LENGTH = "smallCompactionQueueLength";
188   String COMPACTION_QUEUE_LENGTH_DESC = "Length of the queue for compactions.";
189   String FLUSH_QUEUE_LENGTH = "flushQueueLength";
190   String FLUSH_QUEUE_LENGTH_DESC = "Length of the queue for region flushes";
191   String BLOCK_CACHE_FREE_SIZE = "blockCacheFreeSize";
192   String BLOCK_CACHE_FREE_DESC =
193       "Size of the block cache that is not occupied.";
194   String BLOCK_CACHE_COUNT = "blockCacheCount";
195   String BLOCK_CACHE_COUNT_DESC = "Number of block in the block cache.";
196   String BLOCK_CACHE_SIZE = "blockCacheSize";
197   String BLOCK_CACHE_SIZE_DESC = "Size of the block cache.";
198   String BLOCK_CACHE_HIT_COUNT = "blockCacheHitCount";
199   String BLOCK_CACHE_HIT_COUNT_DESC = "Count of the hit on the block cache.";
200   String BLOCK_CACHE_MISS_COUNT = "blockCacheMissCount";
201   String BLOCK_COUNT_MISS_COUNT_DESC =
202       "Number of requests for a block that missed the block cache.";
203   String BLOCK_CACHE_EVICTION_COUNT = "blockCacheEvictionCount";
204   String BLOCK_CACHE_EVICTION_COUNT_DESC =
205       "Count of the number of blocks evicted from the block cache.";
206   String BLOCK_CACHE_HIT_PERCENT = "blockCacheCountHitPercent";
207   String BLOCK_CACHE_HIT_PERCENT_DESC =
208       "Percent of block cache requests that are hits";
209   String BLOCK_CACHE_EXPRESS_HIT_PERCENT = "blockCacheExpressHitPercent";
210   String BLOCK_CACHE_EXPRESS_HIT_PERCENT_DESC =
211       "The percent of the time that requests with the cache turned on hit the cache.";
212   String RS_START_TIME_NAME = "regionServerStartTime";
213   String ZOOKEEPER_QUORUM_NAME = "zookeeperQuorum";
214   String SERVER_NAME_NAME = "serverName";
215   String CLUSTER_ID_NAME = "clusterId";
216   String RS_START_TIME_DESC = "RegionServer Start Time";
217   String ZOOKEEPER_QUORUM_DESC = "Zookeeper Quorum";
218   String SERVER_NAME_DESC = "Server Name";
219   String CLUSTER_ID_DESC = "Cluster Id";
220   String UPDATES_BLOCKED_TIME = "updatesBlockedTime";
221   String UPDATES_BLOCKED_DESC =
222       "Number of MS updates have been blocked so that the memstore can be flushed.";
223   String DELETE_KEY = "delete";
224   String GET_KEY = "get";
225   String INCREMENT_KEY = "increment";
226   String MUTATE_KEY = "mutate";
227   String APPEND_KEY = "append";
228   String REPLAY_KEY = "replay";
229   String SCAN_NEXT_KEY = "scanNext";
230   String SLOW_MUTATE_KEY = "slowPutCount";
231   String SLOW_GET_KEY = "slowGetCount";
232   String SLOW_DELETE_KEY = "slowDeleteCount";
233   String SLOW_INCREMENT_KEY = "slowIncrementCount";
234   String SLOW_APPEND_KEY = "slowAppendCount";
235   String SLOW_MUTATE_DESC =
236       "The number of Multis that took over 1000ms to complete";
237   String SLOW_DELETE_DESC =
238       "The number of Deletes that took over 1000ms to complete";
239   String SLOW_GET_DESC = "The number of Gets that took over 1000ms to complete";
240   String SLOW_INCREMENT_DESC =
241       "The number of Increments that took over 1000ms to complete";
242   String SLOW_APPEND_DESC =
243       "The number of Appends that took over 1000ms to complete";
244 
245   String FLUSHED_CELLS = "flushedCellsCount";
246   String FLUSHED_CELLS_DESC = "The number of cells flushed to disk";
247   String FLUSHED_CELLS_SIZE = "flushedCellsSize";
248   String FLUSHED_CELLS_SIZE_DESC = "The total amount of data flushed to disk, in bytes";
249   String COMPACTED_CELLS = "compactedCellsCount";
250   String COMPACTED_CELLS_DESC = "The number of cells processed during minor compactions";
251   String COMPACTED_CELLS_SIZE = "compactedCellsSize";
252   String COMPACTED_CELLS_SIZE_DESC =
253       "The total amount of data processed during minor compactions, in bytes";
254   String MAJOR_COMPACTED_CELLS = "majorCompactedCellsCount";
255   String MAJOR_COMPACTED_CELLS_DESC =
256       "The number of cells processed during major compactions";
257   String MAJOR_COMPACTED_CELLS_SIZE = "majorCompactedCellsSize";
258   String MAJOR_COMPACTED_CELLS_SIZE_DESC =
259       "The total amount of data processed during major compactions, in bytes";
260 
261   String HEDGED_READS = "hedgedReads";
262   String HEDGED_READS_DESC = "The number of times we started a hedged read";
263   String HEDGED_READ_WINS = "hedgedReadWins";
264   String HEDGED_READ_WINS_DESC =
265       "The number of times we started a hedged read and a hedged read won";
266 
267   String BLOCKED_REQUESTS_COUNT = "blockedRequestCount";
268   String BLOCKED_REQUESTS_COUNT_DESC = "The number of blocked requests because of memstore size is "
269       + "larger than blockingMemStoreSize";
270 
271   String SPLIT_KEY = "splitTime";
272   String SPLIT_REQUEST_KEY = "splitRequestCount";
273   String SPLIT_REQUEST_DESC = "Number of splits requested";
274   String SPLIT_SUCCESS_KEY = "splitSuccessCounnt";
275   String SPLIT_SUCCESS_DESC = "Number of successfully executed splits";
276   String FLUSH_KEY = "flushTime";
277 }