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    String COMPACTIONS_COMPLETED_COUNT = "compactionsCompletedCount";
31    String NUM_BYTES_COMPACTED_COUNT = "numBytesCompactedCount";
32    String NUM_FILES_COMPACTED_COUNT = "numFilesCompactedCount";
33    String COMPACTIONS_COMPLETED_DESC = "Number of compactions that have completed.";
34    String  NUM_BYTES_COMPACTED_DESC =
35        "Sum of filesize on all files entering a finished, successful or aborted, compaction";
36    String NUM_FILES_COMPACTED_DESC =
37        "Number of files that were input for finished, successful or aborted, compactions";
38  
39    /**
40     * Close the region's metrics as this region is closing.
41     */
42    void close();
43  
44    /**
45     * Update related counts of puts.
46     */
47    void updatePut();
48  
49    /**
50     * Update related counts of deletes.
51     */
52    void updateDelete();
53  
54    /**
55     * Update count and sizes of gets.
56     * @param getSize size in bytes of the resulting key values for a get
57     */
58    void updateGet(long getSize);
59  
60    /**
61     * Update the count and sizes of resultScanner.next()
62     * @param scanSize Size in bytes of the resulting key values for a next()
63     */
64    void updateScan(long scanSize);
65    /**
66     * Update related counts of increments.
67     */
68    void updateIncrement();
69  
70    /**
71     * Update related counts of appends.
72     */
73    void updateAppend();
74  
75    /**
76     * Get the aggregate source to which this reports.
77     */
78    MetricsRegionAggregateSource getAggregateSource();
79  
80  
81  }