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.yetus.audience.InterfaceAudience;
022
023/**
024 * This interface will be implemented to allow region server to push table metrics into
025 * MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.
026 */
027@InterfaceAudience.Private
028public interface MetricsTableSource extends Comparable<MetricsTableSource> {
029
030  String READ_REQUEST_COUNT = "readRequestCount";
031  String READ_REQUEST_COUNT_DESC = "Number of read requests";
032  String WRITE_REQUEST_COUNT = "writeRequestCount";
033  String WRITE_REQUEST_COUNT_DESC = "Number of write requests";
034  String TOTAL_REQUEST_COUNT = "totalRequestCount";
035  String TOTAL_REQUEST_COUNT_DESC = "Number of total requests";
036  String MEMSTORE_SIZE = "memstoreSize";
037  String MEMSTORE_SIZE_DESC = "The size of memory stores";
038  String STORE_FILE_SIZE = "storeFileSize";
039  String STORE_FILE_SIZE_DESC = "The size of store files size";
040  String TABLE_SIZE = "tableSize";
041  String TABLE_SIZE_DESC = "Total size of the table in the region server";
042
043  String getTableName();
044
045  /**
046   * Close the table's metrics as all the region are closing.
047   */
048  void close();
049
050  /**
051   * Get the aggregate source to which this reports.
052   */
053  MetricsTableAggregateSource getAggregateSource();
054
055}