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