001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.hbase.regionserver;
020
021import org.apache.hadoop.hbase.io.MetricsIOSource;
022import org.apache.hadoop.hbase.io.MetricsIOWrapper;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * Interface of a factory to create Metrics Sources used inside of regionservers.
027 */
028@InterfaceAudience.Private
029public interface MetricsRegionServerSourceFactory {
030
031  /**
032   * Given a wrapper create a MetricsRegionServerSource.
033   *
034   * @param regionServerWrapper The wrapped region server
035   * @return a Metrics Source.
036   */
037  MetricsRegionServerSource createServer(MetricsRegionServerWrapper regionServerWrapper);
038
039  /**
040   * Create a MetricsRegionSource from a MetricsRegionWrapper.
041   *
042   * @param wrapper The wrapped region
043   * @return A metrics region source
044   */
045  MetricsRegionSource createRegion(MetricsRegionWrapper wrapper);
046
047  /**
048   * Create a MetricsUserSource from a user
049   * @return A metrics user source
050   */
051  MetricsUserSource createUser(String shortUserName);
052
053  /**
054   * Return the singleton instance for MetricsUserAggregateSource
055   * @return A metrics user aggregate source
056   */
057  MetricsUserAggregateSource getUserAggregate();
058
059  /**
060   * Create a MetricsTableSource from a MetricsTableWrapper.
061   *
062   * @param table The table name
063   * @param wrapper The wrapped table aggregate
064   * @return A metrics table source
065   */
066  MetricsTableSource createTable(String table, MetricsTableWrapperAggregate wrapper);
067
068  /**
069   * Get a MetricsTableAggregateSource
070   *
071   * @return A metrics table aggregate source
072   */
073  MetricsTableAggregateSource getTableAggregate();
074
075  /**
076   * Get a MetricsHeapMemoryManagerSource
077   * @return A metrics heap memory manager source
078   */
079  MetricsHeapMemoryManagerSource getHeapMemoryManager();
080
081  /**
082   * Create a MetricsIOSource from a MetricsIOWrapper.
083   *
084   * @return A metrics IO source
085   */
086  MetricsIOSource createIO(MetricsIOWrapper wrapper);
087}