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     * Get the number of requests per second.
97     */
98    double getRequestsPerSecond();
99  
100   /**
101    * Get the total number of requests per second.
102    */
103   long getTotalRequestCount();
104 
105   /**
106    * Get the number of read requests to regions hosted on this region server.
107    */
108   long getReadRequestsCount();
109 
110   /**
111    * Get the number of write requests to regions hosted on this region server.
112    */
113   long getWriteRequestsCount();
114 
115   /**
116    * Get the number of CAS operations that failed.
117    */
118   long getCheckAndMutateChecksFailed();
119 
120   /**
121    * Get the number of CAS operations that passed.
122    */
123   long getCheckAndMutateChecksPassed();
124 
125   /**
126    * Get the Size (in bytes) of indexes in storefiles on disk.
127    */
128   long getStoreFileIndexSize();
129 
130   /**
131    * Get the size (in bytes) of of the static indexes including the roots.
132    */
133   long getTotalStaticIndexSize();
134 
135   /**
136    * Get the size (in bytes) of the static bloom filters.
137    */
138   long getTotalStaticBloomSize();
139 
140   /**
141    * Number of mutations received with WAL explicitly turned off.
142    */
143   long getNumMutationsWithoutWAL();
144 
145   /**
146    * Ammount of data in the memstore but not in the WAL because mutations explicitly had their
147    * WAL turned off.
148    */
149   long getDataInMemoryWithoutWAL();
150 
151   /**
152    * Get the percent of HFiles' that are local.
153    */
154   int getPercentFileLocal();
155 
156   /**
157    * Get the size of the compaction queue
158    */
159   int getCompactionQueueSize();
160 
161   int getSmallCompactionQueueSize();
162 
163   int getLargeCompactionQueueSize();
164 
165   /**
166    * Get the size of the flush queue.
167    */
168   int getFlushQueueSize();
169 
170   /**
171    * Get the size (in bytes) of the block cache that is free.
172    */
173   long getBlockCacheFreeSize();
174 
175   /**
176    * Get the number of items in the block cache.
177    */
178   long getBlockCacheCount();
179 
180   /**
181    * Get the total size (in bytes) of the block cache.
182    */
183   long getBlockCacheSize();
184 
185   /**
186    * Get the count of hits to the block cache
187    */
188   long getBlockCacheHitCount();
189 
190   /**
191    * Get the count of misses to the block cache.
192    */
193   long getBlockCacheMissCount();
194 
195   /**
196    * Get the number of items evicted from the block cache.
197    */
198   long getBlockCacheEvictedCount();
199 
200   /**
201    * Get the percent of all requests that hit the block cache.
202    */
203   double getBlockCacheHitPercent();
204 
205   /**
206    * Get the percent of requests with the block cache turned on that hit the block cache.
207    */
208   int getBlockCacheHitCachingPercent();
209 
210   /**
211    * Force a re-computation of the metrics.
212    */
213   void forceRecompute();
214 
215   /**
216    * Get the amount of time that updates were blocked.
217    */
218   long getUpdatesBlockedTime();
219 }