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 */
018package org.apache.hadoop.hbase.regionserver;
019
020import org.apache.hadoop.hbase.io.MetricsIOSource;
021import org.apache.hadoop.hbase.io.MetricsIOWrapper;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * Interface of a factory to create Metrics Sources used inside of regionservers.
026 */
027@InterfaceAudience.Private
028public interface MetricsRegionServerSourceFactory {
029
030  /**
031   * Given a wrapper create a MetricsRegionServerSource.
032   * @param regionServerWrapper The wrapped region server
033   * @return a Metrics Source.
034   */
035  MetricsRegionServerSource createServer(MetricsRegionServerWrapper regionServerWrapper);
036
037  /**
038   * Create a MetricsRegionSource from a MetricsRegionWrapper.
039   * @param wrapper The wrapped region
040   * @return A metrics region source
041   */
042  MetricsRegionSource createRegion(MetricsRegionWrapper wrapper);
043
044  /**
045   * Create a MetricsUserSource from a user
046   * @return A metrics user source
047   */
048  MetricsUserSource createUser(String shortUserName);
049
050  /**
051   * Return the singleton instance for MetricsUserAggregateSource
052   * @return A metrics user aggregate source
053   */
054  MetricsUserAggregateSource getUserAggregate();
055
056  /**
057   * Create a MetricsTableSource from a MetricsTableWrapper.
058   * @param table   The table name
059   * @param wrapper The wrapped table aggregate
060   * @return A metrics table source
061   */
062  MetricsTableSource createTable(String table, MetricsTableWrapperAggregate wrapper);
063
064  /**
065   * Get a MetricsTableAggregateSource
066   * @return A metrics table aggregate source
067   */
068  MetricsTableAggregateSource getTableAggregate();
069
070  /**
071   * Get a MetricsHeapMemoryManagerSource
072   * @return A metrics heap memory manager source
073   */
074  MetricsHeapMemoryManagerSource getHeapMemoryManager();
075
076  /**
077   * Create a MetricsIOSource from a MetricsIOWrapper.
078   * @return A metrics IO source
079   */
080  MetricsIOSource createIO(MetricsIOWrapper wrapper);
081}