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  /**
22   * This is the interface that will expose RegionServer information to hadoop1/hadoop2
23   * implementations of the MetricsRegionServerSource.
24   */
25  public interface MetricsRegionServerWrapper {
26  
27    /**
28     * Get ServerName
29     */
30    String getServerName();
31  
32    /**
33     * Get the Cluster ID
34     *
35     * @return Cluster ID
36     */
37    String getClusterId();
38  
39    /**
40     * Get the Zookeeper Quorum Info
41     *
42     * @return Zookeeper Quorum Info
43     */
44    String getZookeeperQuorum();
45  
46    /**
47     * Get the co-processors
48     *
49     * @return Co-processors
50     */
51    String getCoprocessors();
52  
53    /**
54     * Get HRegionServer start time
55     *
56     * @return Start time of RegionServer in milliseconds
57     */
58    long getStartCode();
59  
60    /**
61     * The number of online regions
62     */
63    long getNumOnlineRegions();
64  
65    /**
66     * Get the number of stores hosted on this region server.
67     */
68    long getNumStores();
69  
70    /**
71     * Get the number of WAL files of this region server.
72     */
73    long getNumWALFiles();
74    
75    /**
76     * Get the size of WAL files of this region server.
77     */
78    long getWALFileSize();
79  
80    /**
81     * Get the number of WAL files with slow appends for this region server.
82     */
83    long getNumWALSlowAppend();
84  
85      /**
86       * Get the number of store files hosted on this region server.
87       */
88    long getNumStoreFiles();
89  
90    /**
91     * Get the size of the memstore on this region server.
92     */
93    long getMemstoreSize();
94  
95    /**
96     * Get the total size of the store files this region server is serving from.
97     */
98    long getStoreFileSize();
99  
100   /**
101    * Get the number of requests per second.
102    */
103   double getRequestsPerSecond();
104 
105   /**
106    * Get the total number of requests per second.
107    */
108   long getTotalRequestCount();
109 
110   /**
111    * Get the number of read requests to regions hosted on this region server.
112    */
113   long getReadRequestsCount();
114 
115   /**
116    * Get the number of filtered read requests to regions hosted on this region server.
117    */
118   long getFilteredReadRequestsCount();
119 
120   /**
121    * Get the number of write requests to regions hosted on this region server.
122    */
123   long getWriteRequestsCount();
124 
125   /**
126    * Get the number of CAS operations that failed.
127    */
128   long getCheckAndMutateChecksFailed();
129 
130   /**
131    * Get the number of CAS operations that passed.
132    */
133   long getCheckAndMutateChecksPassed();
134 
135   /**
136    * Get the Size (in bytes) of indexes in storefiles on disk.
137    */
138   long getStoreFileIndexSize();
139 
140   /**
141    * Get the size (in bytes) of of the static indexes including the roots.
142    */
143   long getTotalStaticIndexSize();
144 
145   /**
146    * Get the size (in bytes) of the static bloom filters.
147    */
148   long getTotalStaticBloomSize();
149 
150   /**
151    * Number of mutations received with WAL explicitly turned off.
152    */
153   long getNumMutationsWithoutWAL();
154 
155   /**
156    * Ammount of data in the memstore but not in the WAL because mutations explicitly had their
157    * WAL turned off.
158    */
159   long getDataInMemoryWithoutWAL();
160 
161   /**
162    * Get the percent of HFiles' that are local.
163    */
164   double getPercentFileLocal();
165 
166   /**
167    * Get the percent of HFiles' that are local for secondary region replicas.
168    */
169   double getPercentFileLocalSecondaryRegions();
170 
171   /**
172    * Get the size of the split queue
173    */
174   int getSplitQueueSize();
175 
176   /**
177    * Get the size of the compaction queue
178    */
179   int getCompactionQueueSize();
180 
181   int getSmallCompactionQueueSize();
182 
183   int getLargeCompactionQueueSize();
184 
185   /**
186    * Get the size of the flush queue.
187    */
188   int getFlushQueueSize();
189 
190   /**
191    * Get the size (in bytes) of the block cache that is free.
192    */
193   long getBlockCacheFreeSize();
194 
195   /**
196    * Get the number of items in the block cache.
197    */
198   long getBlockCacheCount();
199 
200   /**
201    * Get the total size (in bytes) of the block cache.
202    */
203   long getBlockCacheSize();
204 
205   /**
206    * Get the count of hits to the block cache
207    */
208   long getBlockCacheHitCount();
209 
210   /**
211    * Get the count of hits to primary replica in the block cache
212    */
213   long getBlockCachePrimaryHitCount();
214 
215   /**
216    * Get the count of misses to the block cache.
217    */
218   long getBlockCacheMissCount();
219 
220   /**
221    * Get the count of misses to primary replica in the block cache.
222    */
223   long getBlockCachePrimaryMissCount();
224 
225   /**
226    * Get the number of items evicted from the block cache.
227    */
228   long getBlockCacheEvictedCount();
229 
230   /**
231    * Get the number of items evicted from primary replica in the block cache.
232    */
233   long getBlockCachePrimaryEvictedCount();
234 
235 
236   /**
237    * Get the percent of all requests that hit the block cache.
238    */
239   double getBlockCacheHitPercent();
240 
241   /**
242    * Get the percent of requests with the block cache turned on that hit the block cache.
243    */
244   double getBlockCacheHitCachingPercent();
245 
246   /**
247    * Number of cache insertions that failed.
248    */
249   long getBlockCacheFailedInsertions();
250 
251   /**
252    * Force a re-computation of the metrics.
253    */
254   void forceRecompute();
255 
256   /**
257    * Get the amount of time that updates were blocked.
258    */
259   long getUpdatesBlockedTime();
260 
261   /**
262    * Get the number of cells flushed to disk.
263    */
264   long getFlushedCellsCount();
265 
266   /**
267    * Get the number of cells processed during minor compactions.
268    */
269   long getCompactedCellsCount();
270 
271   /**
272    * Get the number of cells processed during major compactions.
273    */
274   long getMajorCompactedCellsCount();
275 
276   /**
277    * Get the total amount of data flushed to disk, in bytes.
278    */
279   long getFlushedCellsSize();
280 
281   /**
282    * Get the total amount of data processed during minor compactions, in bytes.
283    */
284   long getCompactedCellsSize();
285 
286   /**
287    * Get the total amount of data processed during major compactions, in bytes.
288    */
289   long getMajorCompactedCellsSize();
290 
291   /**
292    * Gets the number of cells moved to mob during compaction.
293    */
294   long getCellsCountCompactedToMob();
295 
296   /**
297    * Gets the number of cells moved from mob during compaction.
298    */
299   long getCellsCountCompactedFromMob();
300 
301   /**
302    * Gets the total amount of cells moved to mob during compaction, in bytes.
303    */
304   long getCellsSizeCompactedToMob();
305 
306   /**
307    * Gets the total amount of cells moved from mob during compaction, in bytes.
308    */
309   long getCellsSizeCompactedFromMob();
310 
311   /**
312    * Gets the number of the flushes in mob-enabled stores.
313    */
314   long getMobFlushCount();
315 
316   /**
317    * Gets the number of mob cells flushed to disk.
318    */
319   long getMobFlushedCellsCount();
320 
321   /**
322    * Gets the total amount of mob cells flushed to disk, in bytes.
323    */
324   long getMobFlushedCellsSize();
325 
326   /**
327    * Gets the number of scanned mob cells.
328    */
329   long getMobScanCellsCount();
330 
331   /**
332    * Gets the total amount of scanned mob cells, in bytes.
333    */
334   long getMobScanCellsSize();
335 
336   /**
337    * Gets the count of accesses to the mob file cache.
338    */
339   long getMobFileCacheAccessCount();
340 
341   /**
342    * Gets the count of misses to the mob file cache.
343    */
344   long getMobFileCacheMissCount();
345 
346   /**
347    * Gets the number of items evicted from the mob file cache.
348    */
349   long getMobFileCacheEvictedCount();
350 
351   /**
352    * Gets the count of cached mob files.
353    */
354   long getMobFileCacheCount();
355 
356   /**
357    * Gets the hit percent to the mob file cache.
358    */
359   double getMobFileCacheHitPercent();
360 
361   /**
362    * @return Count of hedged read operations
363    */
364   long getHedgedReadOps();
365 
366   /**
367    * @return Count of times a hedged read beat out the primary read.
368    */
369   long getHedgedReadWins();
370 
371   /**
372    * @return Count of requests blocked because the memstore size is larger than blockingMemStoreSize
373    */
374   long getBlockedRequestsCount();
375 
376   /**
377    * Get the number of rpc get requests to this region server.
378    */
379   long getRpcGetRequestsCount();
380 
381   /**
382    * Get the number of rpc scan requests to this region server.
383    */
384   long getRpcScanRequestsCount();
385 
386   /**
387    * Get the number of rpc multi requests to this region server.
388    */
389   long getRpcMultiRequestsCount();
390 
391   /**
392    * Get the number of rpc mutate requests to this region server.
393    */
394   long getRpcMutateRequestsCount();
395 }