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