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.wal;
20  
21  import org.apache.hadoop.hbase.metrics.BaseSource;
22  
23  /**
24   * Interface of the source that will export metrics about log replay statistics when recovering a
25   * region server in distributedLogReplay mode
26   */
27  public interface MetricsEditsReplaySource extends BaseSource {
28  
29    /**
30     * The name of the metrics
31     */
32    String METRICS_NAME = "replay";
33  
34    /**
35     * The name of the metrics context that metrics will be under.
36     */
37    String METRICS_CONTEXT = "regionserver";
38  
39    /**
40     * Description
41     */
42    String METRICS_DESCRIPTION = "Metrics about HBase RegionServer WAL Edits Replay";
43  
44    /**
45     * The name of the metrics context that metrics will be under in jmx
46     */
47    String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
48  
49  
50    String REPLAY_TIME_NAME = "replayTime";
51    String REPLAY_TIME_DESC = "Time an replay operation took.";
52    String REPLAY_BATCH_SIZE_NAME = "replayBatchSize";
53    String REPLAY_BATCH_SIZE_DESC = "Number of changes in each replay batch.";
54    String REPLAY_DATA_SIZE_NAME = "replayDataSize";
55    String REPLAY_DATA_SIZE_DESC = "Size (in bytes) of the data of each replay.";
56  
57    /**
58     * Add the time a replay command took
59     */
60    void updateReplayTime(long time);
61  
62    /**
63     * Add the batch size of each replay
64     */
65    void updateReplayBatchSize(long size);
66  
67    /**
68     * Add the payload data size of each replay
69     */
70    void updateReplayDataSize(long size);
71  
72  }