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 HLog files of this region server.
72     */
73    public long getNumHLogFiles();
74    
75    /**
76     * Get the size of HLog files of this region server.
77     */
78    public long getHLogFileSize();
79    
80    /**
81     * Get the number of store files hosted on this region server.
82     */
83    long getNumStoreFiles();
84  
85    /**
86     * Get the size of the memstore on this region server.
87     */
88    long getMemstoreSize();
89  
90    /**
91     * Get the total size of the store files this region server is serving from.
92     */
93    long getStoreFileSize();
94  
95    /**
96     * @return Max age of store files hosted on this region server
97     */
98    long getMaxStoreFileAge();
99  
100   /**
101    * @return Min age of store files hosted on this region server
102    */
103   long getMinStoreFileAge();
104 
105   /**
106    *  @return Average age of store files hosted on this region server
107    */
108   long getAvgStoreFileAge();
109 
110   /**
111    *  @return Number of reference files on this region server
112    */
113   long getNumReferenceFiles();
114 
115   /**
116    * Get the number of requests per second.
117    */
118   double getRequestsPerSecond();
119 
120   /**
121    * Get the total number of requests per second.
122    */
123   long getTotalRequestCount();
124 
125   /**
126    * Get the number of read requests to regions hosted on this region server.
127    */
128   long getReadRequestsCount();
129 
130   /**
131    * Get the number of write requests to regions hosted on this region server.
132    */
133   long getWriteRequestsCount();
134 
135   /**
136    * Get the number of CAS operations that failed.
137    */
138   long getCheckAndMutateChecksFailed();
139 
140   /**
141    * Get the number of CAS operations that passed.
142    */
143   long getCheckAndMutateChecksPassed();
144 
145   /**
146    * Get the Size (in bytes) of indexes in storefiles on disk.
147    */
148   long getStoreFileIndexSize();
149 
150   /**
151    * Get the size (in bytes) of of the static indexes including the roots.
152    */
153   long getTotalStaticIndexSize();
154 
155   /**
156    * Get the size (in bytes) of the static bloom filters.
157    */
158   long getTotalStaticBloomSize();
159 
160   /**
161    * Number of mutations received with WAL explicitly turned off.
162    */
163   long getNumMutationsWithoutWAL();
164 
165   /**
166    * Ammount of data in the memstore but not in the WAL because mutations explicitly had their
167    * WAL turned off.
168    */
169   long getDataInMemoryWithoutWAL();
170 
171   /**
172    * Get the percent of HFiles' that are local.
173    */
174   int getPercentFileLocal();
175 
176   /**
177    * Get the size of the split queue
178    */
179   int getSplitQueueSize();
180 
181   /**
182    * Get the size of the compaction queue
183    */
184   int getCompactionQueueSize();
185 
186   int getSmallCompactionQueueSize();
187 
188   int getLargeCompactionQueueSize();
189 
190   /**
191    * Get the size of the flush queue.
192    */
193   int getFlushQueueSize();
194 
195   /**
196    * Get the size (in bytes) of the block cache that is free.
197    */
198   long getBlockCacheFreeSize();
199 
200   /**
201    * Get the number of items in the block cache.
202    */
203   long getBlockCacheCount();
204 
205   /**
206    * Get the total size (in bytes) of the block cache.
207    */
208   long getBlockCacheSize();
209 
210   /**
211    * Get the count of hits to the block cache
212    */
213   long getBlockCacheHitCount();
214 
215   /**
216    * Get the count of misses to the block cache.
217    */
218   long getBlockCacheMissCount();
219 
220   /**
221    * Get the number of items evicted from the block cache.
222    */
223   long getBlockCacheEvictedCount();
224 
225   /**
226    * Get the percent of all requests that hit the block cache.
227    */
228   int getBlockCacheHitPercent();
229 
230   /**
231    * Get the percent of requests with the block cache turned on that hit the block cache.
232    */
233   int getBlockCacheHitCachingPercent();
234 
235   /**
236    * Number of cache insertions that failed.
237    */
238   long getBlockCacheFailedInsertions();
239 
240   /**
241    * Force a re-computation of the metrics.
242    */
243   void forceRecompute();
244 
245   /**
246    * Get the amount of time that updates were blocked.
247    */
248   long getUpdatesBlockedTime();
249 
250   /**
251    * Get the number of cells flushed to disk.
252    */
253   long getFlushedCellsCount();
254 
255   /**
256    * Get the number of cells processed during minor compactions.
257    */
258   long getCompactedCellsCount();
259 
260   /**
261    * Get the number of cells processed during major compactions.
262    */
263   long getMajorCompactedCellsCount();
264 
265   /**
266    * Get the total amount of data flushed to disk, in bytes.
267    */
268   long getFlushedCellsSize();
269 
270   /**
271    * Get the total amount of data processed during minor compactions, in bytes.
272    */
273   long getCompactedCellsSize();
274 
275   /**
276    * Get the total amount of data processed during major compactions, in bytes.
277    */
278   long getMajorCompactedCellsSize();
279 
280   /**
281    * @return Count of requests blocked because the memstore size is larger than blockingMemStoreSize
282    */
283   long getBlockedRequestsCount();
284 
285   /**
286    * Get the average region size to this region server.
287    */
288   long getAverageRegionSize();
289 
290   long getDataMissCount();
291 
292   long getLeafIndexMissCount();
293 
294   long getBloomChunkMissCount();
295 
296   long getMetaMissCount();
297 
298   long getRootIndexMissCount();
299 
300   long getIntermediateIndexMissCount();
301 
302   long getFileInfoMissCount();
303 
304   long getGeneralBloomMetaMissCount();
305 
306   long getDeleteFamilyBloomMissCount();
307 
308   long getTrailerMissCount();
309 
310   long getDataHitCount();
311 
312   long getLeafIndexHitCount();
313 
314   long getBloomChunkHitCount();
315 
316   long getMetaHitCount();
317 
318   long getRootIndexHitCount();
319 
320   long getIntermediateIndexHitCount();
321 
322   long getFileInfoHitCount();
323 
324   long getGeneralBloomMetaHitCount();
325 
326   long getDeleteFamilyBloomHitCount();
327 
328   long getTrailerHitCount();
329 }