View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.hadoop.hbase.regionserver;
18  
19  import org.apache.hadoop.hbase.TableName;
20  import org.apache.hadoop.hbase.classification.InterfaceAudience;
21  
22  /**
23   * Query Per Second for each table in a RegionServer.
24   */
25  @InterfaceAudience.Private
26  public interface MetricsTableQueryMeter {
27  
28    String TABLE_READ_QUERY_PER_SECOND = "tableReadQueryPerSecond";
29    String TABLE_WRITE_QUERY_PER_SECOND = "tableWriteQueryPerSecond";
30  
31    /**
32     * Update table read QPS
33     * @param tableName The table the metric is for
34     * @param count Number of occurrences to record
35     */
36    void updateTableReadQueryMeter(TableName tableName, long count);
37  
38    /**
39     * Update table read QPS
40     * @param tableName The table the metric is for
41     */
42    void updateTableReadQueryMeter(TableName tableName);
43  
44    /**
45     * Update table write QPS
46     * @param tableName The table the metric is for
47     * @param count Number of occurrences to record
48     */
49    void updateTableWriteQueryMeter(TableName tableName, long count);
50  
51    /**
52     * Update table write QPS
53     * @param tableName The table the metric is for
54     */
55    void updateTableWriteQueryMeter(TableName tableName);
56  }