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 COMPACTIONS_FAILED_COUNT = "compactionsFailedCount";
32    String NUM_BYTES_COMPACTED_COUNT = "numBytesCompactedCount";
33    String NUM_FILES_COMPACTED_COUNT = "numFilesCompactedCount";
34    String COMPACTIONS_COMPLETED_DESC = "Number of compactions that have completed.";
35    String COMPACTIONS_FAILED_DESC = "Number of compactions that have failed.";
36    String  NUM_BYTES_COMPACTED_DESC =
37        "Sum of filesize on all files entering a finished, successful or aborted, compaction";
38    String NUM_FILES_COMPACTED_DESC =
39        "Number of files that were input for finished, successful or aborted, compactions";
40    String COPROCESSOR_EXECUTION_STATISTICS = "coprocessorExecutionStatistics";
41    String COPROCESSOR_EXECUTION_STATISTICS_DESC = "Statistics for coprocessor execution times";
42    String REPLICA_ID = "replicaid";
43    String REPLICA_ID_DESC = "The replica ID of a region. 0 is primary, otherwise is secondary";
44
45    /**
46     * Close the region's metrics as this region is closing.
47     */
48    void close();
49
50    /**
51     * Update related counts of puts.
52     */
53    void updatePut();
54
55    /**
56     * Update related counts of deletes.
57     */
58    void updateDelete();
59
60    /**
61     * Update count and sizes of gets.
62     * @param getSize size in bytes of the resulting key values for a get
63     */
64    void updateGetSize(long getSize);
65
66    /**
67     * Update time of gets
68     * @param mills time for this get operation.
69     */
70    void updateGet(long mills);
71
72    /**
73     * Update the count and sizes of resultScanner.next()
74     * @param scanSize Size in bytes of the resulting key values for a next()
75     */
76    void updateScanSize(long scanSize);
77
78    /**
79     * Update time used of resultScanner.next().
80     * */
81    void updateScanTime(long mills);
82
83    /**
84     * Update related counts of increments.
85     */
86    void updateIncrement();
87
88    /**
89     * Update related counts of appends.
90     */
91    void updateAppend();
92
93    /**
94     * Get the aggregate source to which this reports.
95     */
96    MetricsRegionAggregateSource getAggregateSource();
97
98
99  }