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.metrics.BaseSource;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * This interface will be implemented by a MetricsSource that will export metrics from
026 * multiple regions into the hadoop metrics system.
027 */
028@InterfaceAudience.Private
029public interface MetricsRegionAggregateSource extends BaseSource {
030
031  /**
032   * The name of the metrics
033   */
034  String METRICS_NAME = "Regions";
035
036  /**
037   * The name of the metrics context that metrics will be under.
038   */
039  String METRICS_CONTEXT = "regionserver";
040
041  /**
042   * Description
043   */
044  String METRICS_DESCRIPTION = "Metrics about HBase RegionServer regions and tables";
045
046  /**
047   * The name of the metrics context that metrics will be under in jmx
048   */
049  String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
050
051  String NUMBER_OF_REGIONS_DESC = "Number of regions in the metrics system";
052
053  /**
054   * Register a MetricsRegionSource as being open.
055   *
056   * @param source the source for the region being opened.
057   */
058  void register(MetricsRegionSource source);
059
060  /**
061   * Remove a region's source. This is called when a region is closed.
062   *
063   * @param source The region to remove.
064   */
065  void deregister(MetricsRegionSource source);
066}