View Javadoc

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   * This interface will be implemented to allow single regions to push metrics into
24   * MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.
25   */
26  public interface MetricsRegionSource extends Comparable<MetricsRegionSource> {
27  
28    String OPS_SAMPLE_NAME = "ops";
29    String SIZE_VALUE_NAME = "size";
30  
31    /**
32     * Close the region's metrics as this region is closing.
33     */
34    void close();
35  
36    /**
37     * Update related counts of puts.
38     */
39    void updatePut();
40  
41    /**
42     * Update related counts of deletes.
43     */
44    void updateDelete();
45  
46    /**
47     * Update count and sizes of gets.
48     * @param getSize size in bytes of the resulting key values for a get
49     */
50    void updateGet(long getSize);
51  
52    /**
53     * Update the count and sizes of resultScanner.next()
54     * @param scanSize Size in bytes of the resulting key values for a next()
55     */
56    void updateScan(long scanSize);
57    /**
58     * Update related counts of increments.
59     */
60    void updateIncrement();
61  
62    /**
63     * Update related counts of appends.
64     */
65    void updateAppend();
66  
67    /**
68     * Get the aggregate source to which this reports.
69     */
70    MetricsRegionAggregateSource getAggregateSource();
71  
72  
73  }