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.io.MetricsIOSource;
22 import org.apache.hadoop.hbase.io.MetricsIOWrapper;
23
24 /**
25 * Interface of a factory to create Metrics Sources used inside of regionservers.
26 */
27 public interface MetricsRegionServerSourceFactory {
28
29 /**
30 * Given a wrapper create a MetricsRegionServerSource.
31 *
32 * @param regionServerWrapper The wrapped region server
33 * @return a Metrics Source.
34 */
35 MetricsRegionServerSource createServer(MetricsRegionServerWrapper regionServerWrapper);
36
37 /**
38 * Create a MetricsRegionSource from a MetricsRegionWrapper.
39 *
40 * @param wrapper The wrapped region
41 * @return A metrics region source
42 */
43 MetricsRegionSource createRegion(MetricsRegionWrapper wrapper);
44
45 /**
46 * Create a MetricsTableSource from a MetricsTableWrapper.
47 *
48 * @param table The table name
49 * @param wrapper The wrapped table aggregate
50 * @return A metrics table source
51 */
52 MetricsTableSource createTable(String table, MetricsTableWrapperAggregate wrapper);
53
54 /**
55 * Get a MetricsTableAggregateSource
56 *
57 * @return A metrics table aggregate source
58 */
59 MetricsTableAggregateSource getTableAggregate();
60
61 /**
62 * Create a MetricsIOSource from a MetricsIOWrapper.
63 *
64 * @return A metrics IO source
65 */
66 MetricsIOSource createIO(MetricsIOWrapper wrapper);
67 }